Difference between revisions of "GetCurrentHitPoints"

From NWN Lexicon
Jump to: navigation, search
 
Line 8: Line 8:
  
 
<nwscript>
 
<nwscript>
[[int | int ]] GetCurrentHitPoints(
+
int GetCurrentHitPoints(
    [[object | object ]] oObject = OBJECT_SELF
+
    object oObject = OBJECT_SELF
);
+
);
 
</nwscript>
 
</nwscript>
  

Latest revision as of 01:26, 26 August 2012



GetCurrentHitPoints(object)

Determines the number of hit points someone currently has.

int GetCurrentHitPoints(
    object oObject = OBJECT_SELF
);

Parameters

oObject

The object whose hitpoints we are to retrieve. (Default: OBJECT_SELF)


Description

Returns the number of hitpoints oObject has and 0 if oObject is invalid.



Remarks

This can be called upon any object with hit points - Doors, Placeables and so on therefore have values for this.

It can also be negative, if dying or dead.


Version

1.22

See Also

functions: 

GetPercentageHPLoss



 author: Tom Cassiotis, editor: Jasperre, additional contributor(s): Jasperre