veloren/common/src/comp/energy.rs

use crate::{comp::Body, consts::ENERGY_PER_LEVEL};
use serde::{Deserialize, Serialize};
use specs::{Component, DerefFlaggedStorage};
use specs_idvs::IdvStorage;

#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
pub struct Energy {
    current: u32,
    base_max: u32,
    maximum: u32,
    pub regen_rate: f32,
    pub last_change: Option<(i32, f64, EnergySource)>,
}

#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
pub enum EnergySource {
    Ability,
    Climb,
    LevelUp,
    HitEnemy,
    Regen,
    Revive,
    Unknown,
}

#[derive(Debug)]
pub enum StatChangeError {
    Underflow,
    Overflow,
}

impl Energy {
    pub fn new(body: Body, level: u16) -> Energy {
        let mut energy = Energy::empty();

        energy.update_max_energy(Some(body), level);
        energy.set_to(energy.maximum(), EnergySource::Revive);

        energy
    }

    pub fn empty() -> Self {
        Energy {
            current: 0,
            maximum: 0,
            base_max: 0,
            regen_rate: 0.0,
            last_change: None,
        }
    }

    pub fn current(&self) -> u32 { self.current }

    pub fn base_max(&self) -> u32 { self.base_max }

    pub fn maximum(&self) -> u32 { self.maximum }

    pub fn set_to(&mut self, amount: u32, cause: EnergySource) {
        let amount = amount.min(self.maximum);
        self.last_change = Some((amount as i32 - self.current as i32, 0.0, cause));
        self.current = amount;
    }

    pub fn change_by(&mut self, change: EnergyChange) {
        self.current = ((self.current as i32 + change.amount).max(0) as u32).min(self.maximum);
        self.last_change = Some((change.amount, 0.0, change.source));
    }

    /// This function changes the modified max energy value, not the base energy
    /// value. The modified energy value takes into account buffs and other
    /// temporary changes to max energy.
    pub fn set_maximum(&mut self, amount: u32) {
        self.maximum = amount;
        self.current = self.current.min(self.maximum);
    }

    /// Scales the temporary max energy by a modifier.
    pub fn scale_maximum(&mut self, scaled: f32) {
        let scaled_max = (self.base_max as f32 * scaled) as u32;
        self.set_maximum(scaled_max);
    }

    pub fn try_change_by(
        &mut self,
        amount: i32,
        cause: EnergySource,
    ) -> Result<(), StatChangeError> {
        if self.current as i32 + amount < 0 {
            Err(StatChangeError::Underflow)
        } else if self.current as i32 + amount > self.maximum as i32 {
            Err(StatChangeError::Overflow)
        } else {
            self.change_by(EnergyChange {
                amount,
                source: cause,
            });
            Ok(())
        }
    }

    pub fn update_max_energy(&mut self, body: Option<Body>, level: u16) {
        if let Some(body) = body {
            // Checks the current difference between maximum and base max
            let current_difference = self.maximum as i32 - self.base_max as i32;
            // Sets base max to new value based off of new level provided
            self.base_max = body.base_energy() + ENERGY_PER_LEVEL * level as u32;
            // Calculates new maximum by adding difference to new base max
            let new_maximum = (self.base_max as i32 + current_difference).max(0) as u32;
            // Sets maximum to calculated value
            self.set_maximum(new_maximum);
            // Awards energy
            self.change_by(EnergyChange {
                amount: ENERGY_PER_LEVEL as i32,
                source: EnergySource::LevelUp,
            });
        }
    }

    /// Returns the fraction of energy an entity has remaining
    pub fn fraction(&self) -> f32 { self.current as f32 / self.maximum.max(1) as f32 }
}

pub struct EnergyChange {
    pub amount: i32,
    pub source: EnergySource,
}

impl Component for Energy {
    type Storage = DerefFlaggedStorage<Self, IdvStorage<Self>>;
}
Inline skills::Boost to voxygen code 2021-08-24 20:00:03 +00:00			`use crate::{comp::Body, consts::ENERGY_PER_LEVEL};`
updated dependencies and fixed stuff - replace serde_derive by feature of serde incl. source code modifications to compile - reduce futures-timer to "2.0" to be same as async_std - update notify - removed mio, bincode and lz4 compress in common as networking is now in own crate btw there is a better lz4 compress crate, which is newer than 2017 - update prometheus to 0.9 - can't update uvth yet due to usues - hashbrown to 7.2 to only need a single version - libsqlite3 update - image didn't change as there is a problem with `image 0.23` - switch old directories with newer directories-next - no num upgrade as we still depend on num 0.2 anyways - rodio and cpal upgrade - const-tewaker update - dispatch (untested) update - git2 update - iterations update 2020-07-06 14:23:08 +00:00			`use serde::{Deserialize, Serialize};`
fixed Cargo.lock conflict Fixed `crossbeam-queue` being referenced twice in the lockfile 2021-01-07 20:25:12 +00:00			`use specs::{Component, DerefFlaggedStorage};`
point to github specs to access PairedStorage type, fix Loadout sync spam 2020-07-06 05:56:02 +00:00			`use specs_idvs::IdvStorage;`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00
point to github specs to access PairedStorage type, fix Loadout sync spam 2020-07-06 05:56:02 +00:00			`#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`pub struct Energy {`
			`current: u32,`
StaminaPlus buff, modifying stamina via buffs trying to fix this, coming back to this later please remember to change potion back future self! this ALMOST works. maybe MR ready, kinda jank tho so close, and yet so far... IT WORKS IT WORKS IT WORKS IT WORKS IT WORKS IT WO did the same with health, ill fix this garbage l8r think we're basically done here whoops forgot to change the food back fixing and cleaning up part 1 fixed everything part 2 now with buff images ran clippy + fmt, fixed items that i modified bracket bulldozing, boldly hopefully this should be good? need to rebase real quick please let me be done StaminaPlus buff, modifying stamina via buffs trying to fix this, coming back to this later please remember to change potion back future self! this ALMOST works. maybe MR ready, kinda jank tho so close, and yet so far... IT WORKS IT WORKS IT WORKS IT WORKS IT WORKS IT WO did the same with health, ill fix this garbage l8r think we're basically done here whoops forgot to change the food back fixing and cleaning up part 1 fixed everything part 2 now with buff images ran clippy + fmt, fixed items that i modified hopefully this should be good? cargo clippy fmt stuff deleted an extraneous file?? how did that even...? 2021-01-26 22:47:55 +00:00			`base_max: u32,`
Max energy stat functional. 2021-05-21 00:52:29 +00:00			`maximum: u32,`
Make charging take a discrete amount of energy and change energy regeneration to use floats so it is smoother and tickrate-independent. 2019-11-22 00:53:28 +00:00			`pub regen_rate: f32,`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`pub last_change: Option<(i32, f64, EnergySource)>,`
			`}`

point to github specs to access PairedStorage type, fix Loadout sync spam 2020-07-06 05:56:02 +00:00			`#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`pub enum EnergySource {`
Add ability requirements system 2020-03-17 14:01:41 +00:00			`Ability,`
Update common/src/comp/energy.rs, energy.rs, common/src/sys/controller.rs, common/src/sys/movement.rs, movement.rs files 2020-02-13 07:30:32 +00:00			`Climb,`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`LevelUp,`
feat: hitting enemies with basic_attack gives energy 2020-03-10 17:54:59 +00:00			`HitEnemy,`
Add energy comsumption on rolling and charging, and accelerating regeneration when idle. 2019-11-20 18:31:36 +00:00			`Regen,`
improvement: reset character state and energy on death 2020-01-18 14:00:59 +00:00			`Revive,`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`Unknown,`
			`}`

Make charging take a discrete amount of energy and change energy regeneration to use floats so it is smoother and tickrate-independent. 2019-11-22 00:53:28 +00:00			`#[derive(Debug)]`
			`pub enum StatChangeError {`
			`Underflow,`
			`Overflow,`
			`}`

fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`impl Energy {`
Exp floaters. You load in with correct energy and health values now. 2021-01-04 17:16:42 +00:00			`pub fn new(body: Body, level: u16) -> Energy {`
			`let mut energy = Energy::empty();`

			`energy.update_max_energy(Some(body), level);`
			`energy.set_to(energy.maximum(), EnergySource::Revive);`

			`energy`
			`}`

			`pub fn empty() -> Self {`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`Energy {`
Exp floaters. You load in with correct energy and health values now. 2021-01-04 17:16:42 +00:00			`current: 0,`
			`maximum: 0,`
StaminaPlus buff, modifying stamina via buffs trying to fix this, coming back to this later please remember to change potion back future self! this ALMOST works. maybe MR ready, kinda jank tho so close, and yet so far... IT WORKS IT WORKS IT WORKS IT WORKS IT WORKS IT WO did the same with health, ill fix this garbage l8r think we're basically done here whoops forgot to change the food back fixing and cleaning up part 1 fixed everything part 2 now with buff images ran clippy + fmt, fixed items that i modified bracket bulldozing, boldly hopefully this should be good? need to rebase real quick please let me be done StaminaPlus buff, modifying stamina via buffs trying to fix this, coming back to this later please remember to change potion back future self! this ALMOST works. maybe MR ready, kinda jank tho so close, and yet so far... IT WORKS IT WORKS IT WORKS IT WORKS IT WORKS IT WO did the same with health, ill fix this garbage l8r think we're basically done here whoops forgot to change the food back fixing and cleaning up part 1 fixed everything part 2 now with buff images ran clippy + fmt, fixed items that i modified hopefully this should be good? cargo clippy fmt stuff deleted an extraneous file?? how did that even...? 2021-01-26 22:47:55 +00:00			`base_max: 0,`
Make charging take a discrete amount of energy and change energy regeneration to use floats so it is smoother and tickrate-independent. 2019-11-22 00:53:28 +00:00			`regen_rate: 0.0,`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`last_change: None,`
			`}`
			`}`

apply new rustfmt - touching alot of files 2020-02-01 20:39:39 +00:00			`pub fn current(&self) -> u32 { self.current }`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00
Max energy stat functional. 2021-05-21 00:52:29 +00:00			`pub fn base_max(&self) -> u32 { self.base_max }`

apply new rustfmt - touching alot of files 2020-02-01 20:39:39 +00:00			`pub fn maximum(&self) -> u32 { self.maximum }`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00
			`pub fn set_to(&mut self, amount: u32, cause: EnergySource) {`
			`let amount = amount.min(self.maximum);`
			`self.last_change = Some((amount as i32 - self.current as i32, 0.0, cause));`
			`self.current = amount;`
			`}`

Added energy change server event. 2020-10-30 21:49:58 +00:00			`pub fn change_by(&mut self, change: EnergyChange) {`
			`self.current = ((self.current as i32 + change.amount).max(0) as u32).min(self.maximum);`
			`self.last_change = Some((change.amount, 0.0, change.source));`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`}`

Adressed comments on energy and armor functions. 2021-06-06 23:48:47 +00:00			`/// This function changes the modified max energy value, not the base energy`
			`/// value. The modified energy value takes into account buffs and other`
			`/// temporary changes to max energy.`
StaminaPlus buff, modifying stamina via buffs trying to fix this, coming back to this later please remember to change potion back future self! this ALMOST works. maybe MR ready, kinda jank tho so close, and yet so far... IT WORKS IT WORKS IT WORKS IT WORKS IT WORKS IT WO did the same with health, ill fix this garbage l8r think we're basically done here whoops forgot to change the food back fixing and cleaning up part 1 fixed everything part 2 now with buff images ran clippy + fmt, fixed items that i modified bracket bulldozing, boldly hopefully this should be good? need to rebase real quick please let me be done StaminaPlus buff, modifying stamina via buffs trying to fix this, coming back to this later please remember to change potion back future self! this ALMOST works. maybe MR ready, kinda jank tho so close, and yet so far... IT WORKS IT WORKS IT WORKS IT WORKS IT WORKS IT WO did the same with health, ill fix this garbage l8r think we're basically done here whoops forgot to change the food back fixing and cleaning up part 1 fixed everything part 2 now with buff images ran clippy + fmt, fixed items that i modified hopefully this should be good? cargo clippy fmt stuff deleted an extraneous file?? how did that even...? 2021-01-26 22:47:55 +00:00			`pub fn set_maximum(&mut self, amount: u32) {`
			`self.maximum = amount;`
			`self.current = self.current.min(self.maximum);`
			`}`

Adressed comments on energy and armor functions. 2021-06-06 23:48:47 +00:00			`/// Scales the temporary max energy by a modifier.`
Max energy stat functional. 2021-05-21 00:52:29 +00:00			`pub fn scale_maximum(&mut self, scaled: f32) {`
			`let scaled_max = (self.base_max as f32 * scaled) as u32;`
			`self.set_maximum(scaled_max);`
			`}`

Make charging take a discrete amount of energy and change energy regeneration to use floats so it is smoother and tickrate-independent. 2019-11-22 00:53:28 +00:00			`pub fn try_change_by(`
			`&mut self,`
			`amount: i32,`
			`cause: EnergySource,`
			`) -> Result<(), StatChangeError> {`
			`if self.current as i32 + amount < 0 {`
			`Err(StatChangeError::Underflow)`
			`} else if self.current as i32 + amount > self.maximum as i32 {`
			`Err(StatChangeError::Overflow)`
			`} else {`
Added energy change server event. 2020-10-30 21:49:58 +00:00			`self.change_by(EnergyChange {`
			`amount,`
			`source: cause,`
			`});`
Make charging take a discrete amount of energy and change energy regeneration to use floats so it is smoother and tickrate-independent. 2019-11-22 00:53:28 +00:00			`Ok(())`
			`}`
			`}`

Exp floaters. You load in with correct energy and health values now. 2021-01-04 17:16:42 +00:00			`pub fn update_max_energy(&mut self, body: Option<Body>, level: u16) {`
			`if let Some(body) = body {`
Adressed comments on energy and armor functions. 2021-06-06 23:48:47 +00:00			`// Checks the current difference between maximum and base max`
			`let current_difference = self.maximum as i32 - self.base_max as i32;`
			`// Sets base max to new value based off of new level provided`
			`self.base_max = body.base_energy() + ENERGY_PER_LEVEL * level as u32;`
			`// Calculates new maximum by adding difference to new base max`
			`let new_maximum = (self.base_max as i32 + current_difference).max(0) as u32;`
			`// Sets maximum to calculated value`
			`self.set_maximum(new_maximum);`
			`// Awards energy`
Fixed base energy being 0. 2021-01-27 02:25:00 +00:00			`self.change_by(EnergyChange {`
Max energy stat functional. 2021-05-21 00:52:29 +00:00			`amount: ENERGY_PER_LEVEL as i32,`
Fixed base energy being 0. 2021-01-27 02:25:00 +00:00			`source: EnergySource::LevelUp,`
			`});`
Exp floaters. You load in with correct energy and health values now. 2021-01-04 17:16:42 +00:00			`}`
			`}`
Deduplicate bar text 2021-07-20 19:28:16 +00:00
			`/// Returns the fraction of energy an entity has remaining`
Added comments on PositionSpecifier usage 2021-07-24 18:41:07 +00:00			`pub fn fraction(&self) -> f32 { self.current as f32 / self.maximum.max(1) as f32 }`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`}`

Added energy change server event. 2020-10-30 21:49:58 +00:00			`pub struct EnergyChange {`
			`pub amount: i32,`
			`pub source: EnergySource,`
			`}`

fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`impl Component for Energy {`
fixed Cargo.lock conflict Fixed `crossbeam-queue` being referenced twice in the lockfile 2021-01-07 20:25:12 +00:00			`type Storage = DerefFlaggedStorage<Self, IdvStorage<Self>>;`
fixing #405 - Energy as its own component 2020-01-12 16:43:25 +00:00			`}`