Struct game_features::StatDefinition [−][src]
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>, }
Expand description
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
Expand description
The key.
name: String
Expand description
The name.
friendly_name: String
Expand description
The computer friendly name.
default_value: f64
Expand description
The default value.
min_value: Option<f64>
Expand description
The minimum value.
max_value: Option<f64>
Expand description
The maximum value.
icon_path: Option<String>
Expand description
The icon of this stat.
Implementations
impl<K> StatDefinition<K>
[src]
impl<K> StatDefinition<K>
[src]impl<K: Clone> StatDefinition<K>
[src]
impl<K: Clone> StatDefinition<K>
[src]pub fn default_instance(&self) -> StatInstance<K>
[src]
pub fn default_instance(&self) -> StatInstance<K>
[src]Creates the default StatInstance for this StatDefinition.
Trait Implementations
impl<K: Clone> Clone for StatDefinition<K>
[src]
impl<K: Clone> Clone for StatDefinition<K>
[src]fn clone(&self) -> StatDefinition<K>
[src]
fn clone(&self) -> StatDefinition<K>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<K: Debug> Debug for StatDefinition<K>
[src]
impl<K: Debug> Debug for StatDefinition<K>
[src]impl<'de, K> Deserialize<'de> for StatDefinition<K> where
K: Deserialize<'de>,
[src]
impl<'de, K> Deserialize<'de> for StatDefinition<K> where
K: Deserialize<'de>,
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl<K> RefUnwindSafe for StatDefinition<K> where
K: RefUnwindSafe,
K: RefUnwindSafe,
impl<K> Send for StatDefinition<K> where
K: Send,
K: Send,
impl<K> Sync for StatDefinition<K> where
K: Sync,
K: Sync,
impl<K> Unpin for StatDefinition<K> where
K: Unpin,
K: Unpin,
impl<K> UnwindSafe for StatDefinition<K> where
K: UnwindSafe,
K: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,