Struct Health 

pub struct Health {
    current: u32,
    base_max: u32,
    maximum: u32,
    pub last_change: HealthChange,
    pub is_dead: bool,
    pub can_have_death_protection: bool,
    pub death_protection: bool,
    damage_contributors: HashMap<DamageContributor, (u64, Time)>,
}

Health is represented by u32s within the module, but treated as a float by the rest of the game.

Fields

current: u32

Current health is how much health the entity currently has. Current health must be lower than or equal to maximum health.

base_max: u32

Base max is the amount of health the entity has without considering temporary modifiers such as buffs

maximum: u32

Maximum is the amount of health the entity has after temporary modifiers are considered

last_change: HealthChange

The last change to health

is_dead: bool

can_have_death_protection: bool

If this entity supports having death protection.

death_protection: bool

If death protection is true, any damage that would kill instead leaves the entity at 1 health.

damage_contributors: HashMap<DamageContributor, (u64, Time)>

Keeps track of damage per DamageContributor and the last time they caused damage, used for EXP sharing

Implementations

impl Health

pub const HEALTH_EPSILON: f32

Used when comparisons to health are needed outside this module.

const MAX_HEALTH: u16

Maximum value allowed for health before scaling

const MAX_SCALED_HEALTH: u32

The maximum value allowed for current and maximum health Maximum value is (u16:MAX - 1) * 256, which only requires 24 bits. This can fit into an f32 with no loss to precision

const SCALING_FACTOR_FLOAT: f32 = 256.

The amount health is scaled by within this module

const SCALING_FACTOR_INT: u32

pub fn current(&self) -> f32

Returns the current value of health casted to a float

pub fn base_max(&self) -> f32

Returns the base maximum value of health casted to a float

pub fn maximum(&self) -> f32

Returns the maximum value of health casted to a float

pub fn fraction(&self) -> f32

Returns the fraction of health an entity has remaining

pub fn set_fraction(&mut self, fraction: f32)

Instantly set the health fraction.

pub fn set_amount(&mut self, amount: f32)

pub fn needs_maximum_update(&self, modifiers: StatsModifier) -> Option<u32>

Calculates a new maximum value and returns it if the value differs from the current maximum.

Note: The returned value uses an internal format so don’t expect it to be useful for anything other than a parameter to Self::update_internal_integer_maximum.

pub fn update_internal_integer_maximum(&mut self, maximum: u32)

Updates the maximum value for health.

Note: The accepted u32 value is in the internal format of this type. So attempting to pass values that weren’t returned from Self::needs_maximum_update can produce strange or unexpected results.

pub fn new(body: Body) -> Self

pub fn change_by(&mut self, change: HealthChange) -> bool

Returns a boolean if the delta was not zero.

pub fn damage_contributions( &self, ) -> impl Iterator<Item = (&DamageContributor, &u64)>

pub fn recent_damagers(&self) -> impl Iterator<Item = (Uid, Time)> + '_

pub fn should_die(&self) -> bool

pub fn kill(&mut self)

pub fn revive(&mut self)

pub fn consume_death_protection(&mut self)

pub fn refresh_death_protection(&mut self)

pub fn has_consumed_death_protection(&self) -> bool

Trait Implementations

impl Clone for Health

fn clone(&self) -> Health

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Health

type Storage = DerefFlaggedStorage<Health, VecStorage<Health>>

Associated storage type for this component.

impl Debug for Health

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Health

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Health

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.