The LifeMeter is an ActorFrame that provides a few functions to determine the current state of the player's health.
The way LifeMeter returns the value for the functions is based on the player's current Life Type, which can be one of the following three:
GetLife
Returns the current life of the player.
Returns a value from 0 to 1.
Returns a converted value from the current lifes left and the starting ammount of batteries.
Lives Left / Batteries Max
Retuns a converted value from the current time remaining against a hard-coded value of 90. This value is clamped to return a value from 0 to 1.
Time Left / 90.
IsInDanger
Returns true
if the player is in a danger situation. For all three life types, this is determined by a DangerThreshold
metric.
IsHot
Returns true
if the player is Hot
. This means that the player currently has max health. This applies for Bar and Battery.
The Time life type will never return true, despite reaching its max time.
IsFailing
Linked to the Passmark
modifier, it will return true
if the player's current life is under the value of Passmark
.
Returns true
if the player has run out of batteries.
Returns true
if the player has run out of time.