Struct game_features::StatDefinition

pub struct StatDefinition<K> {
    pub key: K,
    pub name: String,
    pub friendly_name: String,
    pub default_value: f64,
    pub min_value: Option<f64>,
    pub max_value: Option<f64>,
    pub icon_path: Option<String>,
}

The definition of a stat. A stat is a named float value optionally constrained between two other values and with a default value. It is used to create effects, conditions and in general to hold state for each entity. For example, it can be used to contain the health or mana of an entity just as well as it can be used to keep track of the number of enemies positioned around an entity.

Fields

key: K

The key.

name: String

The name.

friendly_name: String

The computer friendly name.

default_value: f64

The default value.

min_value: Option<f64>

The minimum value.

max_value: Option<f64>

The maximum value.

icon_path: Option<String>

The icon of this stat.

Implementations

impl<K> StatDefinition<K>

pub fn new(
    key: K,
    name: String,
    friendly_name: String,
    default_value: f64
) -> Self

Constructs a new StatDefinition.

impl<K: Clone> StatDefinition<K>

pub fn default_instance(&self) -> StatInstance<K>

Creates the default StatInstance for this StatDefinition.

Trait Implementations

impl<K: Clone> Clone for StatDefinition<K>

fn clone(&self) -> StatDefinition<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for StatDefinition<K>

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

Formats the value using the given formatter.

impl<'de, K> Deserialize<'de> for StatDefinition<K> where
    K: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<K> Serialize for StatDefinition<K> where
    K: Serialize, 

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

Serialize this value into the given Serde serializer.