new Health()
The Health component provides the ability for Game Objects to have a health property
that can be damaged and reset through game code.
Requires the LifeSpan component.
- Source - gameobjects/components/Health.js, line 14
Members
-
damage
-
Damages the Game Object. This removes the given amount of health from the
healthproperty.If health is taken below or is equal to zero then the
killmethod is called.- Source - gameobjects/components/Health.js, line 46
-
heal
-
Heal the Game Object. This adds the given amount of health to the
healthproperty.- Source - gameobjects/components/Health.js, line 90
-
health :number
-
The Game Objects health value. This is a handy property for setting and manipulating health on a Game Object.
It can be used in combination with the
damagemethod or modified directly.- Default Value:
- 1
- Source - gameobjects/components/Health.js, line 26
-
maxHealth :number
-
The Game Objects maximum health value. This works in combination with the
healmethod to ensure the health value never exceeds the maximum.- Default Value:
- 100
- Source - gameobjects/components/Health.js, line 35
-
setHealth
-
Sets the health property of the Game Object to the given amount. Will never exceed the
maxHealthvalue.- Source - gameobjects/components/Health.js, line 70