PlayerHealth: Difference between revisions
DrinkyBird (talk | contribs) No edit summary |
DrinkyBird (talk | contribs) No edit summary Tag: Source edit |
||
| Line 2: | Line 2: | ||
int '''PlayerHealth''' (void) | int '''PlayerHealth''' (void) | ||
==Usage== | == Usage == | ||
=== Return value === | |||
Returns the amount of health the activator of the script has. Returns zero if the activator is world. | Returns the amount of health the activator of the script has. Returns zero if the activator is world. | ||
This is equivalent to <code> | This function is equivalent to <code>{{Zdoomwiki|GetActorProperty}}(0, APROP_Health)</code>. | ||
== Examples == | |||
<syntaxhighlight lang="c" line="1"> | <syntaxhighlight lang="c" line="1"> | ||
Script 1 (void) | Script 1 (void) | ||
| Line 24: | Line 23: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[category:ACS | [[category:ACS functions]] | ||
Latest revision as of 00:33, 3 July 2022
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
int PlayerHealth (void)
Usage
Return value
Returns the amount of health the activator of the script has. Returns zero if the activator is world.
This function is equivalent to 
GetActorProperty(0, APROP_Health)
Examples
Script 1 (void)
{
if (PlayerHealth() > 75)
{
Print(s: "You have a lot of health!");
}
else
{
Print(s: "You might want to find a medkit!");
}
}