Struct game_library::StatBonus

pub struct StatBonus {
    pub value: f32,
}

A stat bonus is a value that can be increased or decreased. These should be considered values that operate on a percentage scale, where 1.0 is 100% (i.e. no change), 0.5 is 50% (i.e. half), and 2.0 is 200% (i.e. double).

This is a very simple struct, but it’s useful for things like damage multipliers, or movement speed multipliers.

Note

This does not support negative values, they don’t make sense for a percentage based multiplier. If a value would become negative, it will be clamped to 0.0 instead.

Fields

value: f32

The percentage bonus to apply to the stat.

Implementations

impl StatBonus

pub const fn new(value: f32) -> Self

Creates a new stat bonus with the given value.

pub const fn value(&self) -> f32

Returns the value of the stat bonus.

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

Sets the value of the stat bonus.

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

Adds the given value to the stat bonus.

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

Subtracts the given value from the stat bonus.

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

Multiplies the stat bonus by the given value.

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

Divides the stat bonus by the given value.

pub fn add_percent(&mut self, percent: impl Into<f32>)

Percentage-based addition, where the given value is a percentage to add to the stat bonus. For example, if the stat bonus is 1.0, and the given value is 50, the result will be 1.5.

This is to provide a more convenient way to add percentages to the stat bonus.

pub fn subtract_percent(&mut self, percent: impl Into<f32>)

Percentage-based subtraction, where the given value is a percentage to subtract from the stat bonus. For example, if the stat bonus is 1.0, and the given value is 50, the result will be 0.5.

This is to provide a more convenient way to subtract percentages from the stat bonus.

pub fn multiply_percent(&mut self, percent: impl Into<f32>)

Percentage-based multiplication, where the given value is a percentage to multiply the stat bonus by. For example, if the stat bonus is 1.0, and the given value is 75, the result will be 0.75.

This is to provide a more convenient way to multiply percentages to the stat bonus.

pub fn divide_percent(&mut self, percent: impl Into<f32>)

Percentage-based division, where the given value is a percentage to divide the stat bonus by. For example, if the stat bonus is 1.0, and the given value is 50, the result will be 2.0.

This is to provide a more convenient way to divide percentages from the stat bonus.

Trait Implementations

impl Add for StatBonus

type Output = f32

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for StatBonus

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for StatBonus

fn clone(&self) -> StatBonus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for StatBonus

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 StatBonus

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

Formats the value using the given formatter.

impl Default for StatBonus

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StatBonus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StatBonus

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

Formats the value using the given formatter.

impl Div for StatBonus

type Output = f32

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign for StatBonus

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl FromReflect for StatBonus

where f32: 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<StatBonus> for InspectorOptions

fn from_type() -> Self

impl GetTypeRegistration for StatBonus

where f32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Mul for StatBonus

type Output = f32

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign for StatBonus

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for StatBonus

type Output = f32

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for StatBonus

fn cmp(&self, other: &Self) -> Ordering

We are comparing floats, but we aren’t so worried about precision because these are just percentages. So we multiply by 100, convert to u32, and compare those.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StatBonus

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reflect for StatBonus

where f32: 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 StatBonus

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 StatBonus

where f32: 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 Sub for StatBonus

type Output = f32

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for StatBonus

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TypePath for StatBonus

where f32: 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 StatBonus

where f32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for StatBonus

impl Eq for StatBonus

impl Resource for StatBonus

where Self: Send + Sync + 'static,

impl StructuralPartialEq for StatBonus