Old definition kept for reference. For the new see: http://svn.wildfiregames.com/entity-docs/#component.Health

An object with this trait has a certain number of hitpoints that sustains him.

Example:

        <Traits>
  		<Health>
  			<Max>100</Max>
  			
  			<Bar_Height>-1.0</Bar_Height>
    			
  			<Regen_Rate>5.0</Regen_Rate>
  			<Decay_Rate>1.0</Decay_Rate>
    			
                        <Vacant>100</Vacant>
    		</Health>
  	</Traits>

Max

BRIEF DESCRIPTION :: The maximum base number of hitpoints the object can have.

Hitpoints are the 'life points' of an entity. When an entity's hit points reach zero, the instance of that entity is destroyed.

Note: A value of zero means that the entity is invulnerable (cannot lose hitpoints, cannot be destroyed).

The attribute Traits.Health.Curr is created when the entity is initialised, and stores the entity's current hitpoints (default is the same as Traits.Health.Max).

Bar_Height

BRIEF DESCRIPTION :: Indicates the offset from the entity's Traits.Footprint.Height at which the entity's hitpoint bar appears above his head (used for finer tweaking of the bar's position).

An entity without this property has no hitpoint bar.

Regen_Rate

BRIEF DESCRIPTION :: The object regenerates hitpoints at this rate until it reaches its Traits.Health.Max hitpoints.

Not yet implemented.

If an entity has this attribute, it will regenerate hitpoints untill it reaches the Traits.Health.Max value.

Most all of the humanoid and cavalry units in the game will regenerate their hitpoints over a specified period of time. This attribute controls that rate. Healing can be accelerated by Healer units and Temples.

Decay_Rate

BRIEF DESCRIPTION :: The entity loses hitpoints over time (as might happen with, say, an unattended Field or a summoned unit in an RPG).

Not yet implemented.

Vacant

BRIEF DESCRIPTION :: The entity must have someone garrisoned in it in order to retain its hitpoints. (Fields, for example.)

Not yet implemented.

This value determines the number of unattended seconds that can elapse before its hitpoints begins to decay (see Traits.Health.Decay).

Last modified 5 years ago Last modified on Oct 2, 2011 4:27:23 PM