Struct veloren_common::comp::energy::Energy

pub struct Energy {
    current: u32,
    base_max: u32,
    maximum: u32,
    regen_rate: f32,
}

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

Fields

current: u32

Current energy is how much energy the entity currently has

base_max: u32

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

maximum: u32

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

regen_rate: f32

Rate of regeneration per tick. Starts at zero and accelerates.

Implementations

impl Energy

pub const ENERGY_EPSILON: f32 = 2.98032319E-8f32

Used when comparisons to energy are needed outside this module.

const MAX_ENERGY: u16 = 65_534u16

Maximum value allowed for energy before scaling

const MAX_SCALED_ENERGY: u32 = 16_776_704u32

The maximum value allowed for current and maximum energy 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 = 256f32

The amount energy is scaled by within this module

const SCALING_FACTOR_INT: u32 = 256u32

pub fn current(&self) -> f32

Returns the current value of energy casted to a float

pub fn base_max(&self) -> f32

Returns the base maximum value of energy casted to a float

pub fn maximum(&self) -> f32

Returns the maximum value of energy casted to a float

pub fn fraction(&self) -> f32

Returns the fraction of energy an entity has remaining

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_maximum].

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

Updates the maximum value for energy.

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 needs_regen(&self) -> bool

Returns true if the current value is less than the maximum

pub fn regen(&mut self, accel: f32, dt: f32)

Regenerates energy based on the provided acceleration

pub fn needs_regen_rate_reset(&self) -> bool

Checks whether the regen_rate is zero or not. Returns true if the value is anything other than 0.0.

pub fn reset_regen_rate(&mut self)

Resets the energy regeneration rate to zero

pub fn change_by(&mut self, change: f32)

pub fn try_change_by(&mut self, change: f32) -> Result<(), ()>

pub fn refresh(&mut self)

Trait Implementations

impl Clone for Energy

fn clone(&self) -> Energy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Energy

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

Associated storage type for this component.

impl Debug for Energy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Energy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Energy

fn eq(&self, other: &Energy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Energy

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Energy

impl StructuralPartialEq for Energy