Struct veloren_common::comp::poise::Poise

pub struct Poise {
    current: u32,
    base_max: u32,
    maximum: u32,
    pub last_change: Dir,
    regen_rate: f32,
    last_stun_time: Option<Time>,
    pub previous_state: PoiseState,
}

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

Fields

current: u32

Current poise is how much poise the entity currently has

base_max: u32

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

maximum: u32

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

last_change: Dir

Direction that the last poise change came from

regen_rate: f32

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

last_stun_time: Option<Time>

Time that entity was last in a poise state

previous_state: PoiseState

The previous poise state

Implementations

impl Poise

const MAX_POISE: u16 = 65_534u16

Maximum value allowed for poise before scaling

const MAX_SCALED_POISE: u32 = 16_776_704u32

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

pub const POISE_BUFFER_TIME: f64 = 1f64

The amount of time after being in a poise state before you can take poise damage again

pub const POISE_EPSILON: f32 = 2.98032319E-8f32

Used when comparisons to poise are needed outside this module.

pub const POISE_THRESHOLDS: [f32; 4] = _

The thresholds where poise changes to a different state

const SCALING_FACTOR_FLOAT: f32 = 256f32

The amount poise is scaled by within this module

const SCALING_FACTOR_INT: u32 = 256u32

pub fn current(&self) -> f32

Returns the current value of poise casted to a float

pub fn base_max(&self) -> f32

Returns the base maximum value of poise casted to a float

pub fn maximum(&self) -> f32

Returns the maximum value of poise casted to a float

pub fn fraction(&self) -> f32

Returns the fraction of poise an entity has remaining

pub fn update_maximum(&mut self, modifiers: StatsModifier)

Updates the maximum value for poise

pub fn new(body: Body) -> Self

pub fn change(&mut self, change: PoiseChange)

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, now: Time)

Regenerates poise based on a provided acceleration

pub fn reset(&mut self, time: Time, poise_state_time: f64)

pub fn knockback(&self) -> Dir

Returns knockback as a Dir Kept as helper function should additional fields ever be added to last change

pub fn poise_state(&self) -> PoiseState

Defines the poise states based on current poise value

pub fn compute_poise_damage_reduction( inventory: Option<&Inventory>, msm: &MaterialStatManifest, char_state: Option<&CharacterState>, stats: Option<&Stats> ) -> f32

Returns the total poise damage reduction provided by all equipped items

pub fn apply_poise_reduction( value: f32, inventory: Option<&Inventory>, msm: &MaterialStatManifest, char_state: Option<&CharacterState>, stats: Option<&Stats> ) -> f32

Modifies a poise change when optionally given an inventory and character state to aid in calculation of poise damage reduction

Trait Implementations

impl Clone for Poise

fn clone(&self) -> Poise

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Poise

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

Associated storage type for this component.

impl Debug for Poise

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Poise

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Poise

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 Poise