Struct game_library::Stat

pub struct Stat { /* private fields */ }

A stat is a value that should be used to represent a character’s speed, strength or other statistic. This is not an [game_library::Attribute] which has a maximum and exists between 0 and that maximum. A stat is a value that really is a value which can be used directly in the game.

Things you might use Stat for:

• speed
• defense
• base damage
• damage reduction
• attack speed
• other items in [game_library::enums::StatEnum]

Implementations

impl Stat

pub fn new(base_value: f32) -> Self

Creates a new stat bundle with the given base value. This sets the initial bonus value to its default of 1.0.

Arguments

• base_value - The base value of the stat.

Returns

• A new stat bundle with the given base value.

Examples

use game_library::Stat;

let stat = Stat::new(10.0);
assert_eq!(stat.value(), 10.0);
assert_eq!(stat.base_value(), 10.0);
assert_eq!(stat.bonus(), 1.0);

pub const fn value(&self) -> f32

Returns the current value of the stat.

Examples

use game_library::Stat;

let mut stat = Stat::new(6.0);
assert_eq!(stat.value(), 6.0);
stat.add_bonus(0.5);
assert_eq!(stat.value(), 9.0);

pub const fn bonus(&self) -> f32

Returns the current bonus of the stat.

Examples

use game_library::Stat;

let mut stat = Stat::new(10.0);
assert_eq!(stat.bonus(), 1.0);
stat.add_bonus(0.5);
assert_eq!(stat.bonus(), 1.5);

pub const fn base_value(&self) -> f32

Returns the base value of the stat.

Examples

use game_library::Stat;

let mut stat = Stat::new(6.0);
assert_eq!(stat.base_value(), 6.0);
stat.add_bonus(0.5);
assert_eq!(stat.base_value(), 6.0);
stat.add_base_value(1.0);
assert_eq!(stat.base_value(), 7.0);

pub fn add_base_value(&mut self, value: f32)

Add to the base value of the stat. The base value is one part of what makes up the final value of the stat. The other part is the bonus.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to add to the base value.

Examples

use game_library::Stat;

let mut stat = Stat::new(6.0);
assert_eq!(stat.base_value(), 6.0);
assert_eq!(stat.value(), 6.0);
stat.add_base_value(1.0);
assert_eq!(stat.base_value(), 7.0);
assert_eq!(stat.value(), 7.0);
stat.add_bonus(0.5);
assert_eq!(stat.base_value(), 7.0);
assert_eq!(stat.value(), 10.5);
// Now when we add one to the base value, we can see `value()` is updated against the new bonus.
stat.add_base_value(1.0);
assert_eq!(stat.base_value(), 8.0);
assert_eq!(stat.value(), 12.0);

pub fn subtract_base_value(&mut self, value: f32)

Subtract from the base value of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to subtract from the base value.

pub fn multiply_base_value(&mut self, value: f32)

Multiply the base value of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to multiply the base value by.

pub fn divide_base_value(&mut self, value: f32)

Divide the base value of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to divide the base value by.

pub fn add_bonus(&mut self, value: f32)

Add to the bonus of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to add to the bonus.

See StatBonus::add_value for more information.

pub fn subtract_bonus(&mut self, value: f32)

Subtract from the bonus of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to subtract from the bonus.

See StatBonus::subtract_value for more information.

pub fn multiply_bonus(&mut self, value: f32)

Multiply the bonus of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to multiply the bonus by.

See StatBonus::multiply_value for more information.

pub fn divide_bonus(&mut self, value: f32)

Divide the bonus of the stat.

This will also update the value of the stat. (Apply the bonus to the new base value, updating what value() returns.)

Arguments

• value - The value to divide the bonus by.

See StatBonus::divide_value for more information.

pub fn set_base_value(&mut self, value: f32)

Set the base value of the stat.

This will overwrite the existing base value.

Arguments

• value - The value to set the base value to.

Examples

use game_library::Stat;

let mut stat = Stat::new(10.0);
assert_eq!(stat.base_value(), 10.0);
assert_eq!(stat.value(), 10.0);
stat.set_base_value(5.0);
assert_eq!(stat.base_value(), 5.0);
assert_eq!(stat.value(), 5.0);

pub fn set_bonus_value(&mut self, value: f32)

Set the bonus of the stat.

This will overwrite the existing bonus.

Arguments

• value - The value to set the bonus to.

Examples

use game_library::Stat;

let mut stat = Stat::new(10.0);
assert_eq!(stat.bonus(), 1.0);
assert_eq!(stat.value(), 10.0);
stat.set_bonus_value(5.0);
assert_eq!(stat.bonus(), 5.0);
assert_eq!(stat.value(), 50.0);

Trait Implementations

impl Clone for Stat

fn clone(&self) -> Stat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Stat

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for Stat

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

Formats the value using the given formatter.

impl Default for Stat

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Stat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Stat

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

Formats the value using the given formatter.

impl From<f32> for Stat

fn from(value: f32) -> Self

Converts to this type from the input type.

impl FromReflect for Stat

where f32: FromReflect + TypePath, StatBonus: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl FromType<Stat> for InspectorOptions

fn from_type() -> Self

impl GetTypeRegistration for Stat

where f32: FromReflect + TypePath, StatBonus: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl PartialEq for Stat

fn eq(&self, other: &Stat) -> 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 Reflect for Stat

where f32: FromReflect + TypePath, StatBonus: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for Stat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Stat

where f32: FromReflect + TypePath, StatBonus: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl TypePath for Stat

where f32: FromReflect + TypePath, StatBonus: FromReflect + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Stat

where f32: FromReflect + TypePath, StatBonus: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Stat

impl Resource for Stat

where Self: Send + Sync + 'static,

impl StructuralPartialEq for Stat