Struct game_features::SkillDefinition

pub struct SkillDefinition<K, E, S, I> {
    pub key: S,
    pub name: String,
    pub friendly_name: String,
    pub description: String,
    pub cooldown: f64,
    pub passive: bool,
    pub conditions: Vec<StatCondition<K>>,
    pub item_conditions: Vec<(I, usize, UseMode)>,
    pub stat_effectors: Vec<E>,
}

The definition of an usable skill.

Fields

key: S

The id of this skill.

name: String

The name.

friendly_name: String

The computer friendly name.

description: String

The complete description of this skill.

cooldown: f64

The cooldown between usages of this skill.

passive: bool

Whether this skill is will activate automatically once all conditions are met or if it needs to be manually activated.

conditions: Vec<StatCondition<K>>

The stats conditions required to activate this skill.

item_conditions: Vec<(I, usize, UseMode)>

The item conditions required to activate this skill.

stat_effectors: Vec<E>

The caused stat effectors.

Implementations

impl<K, E, S, I> SkillDefinition<K, E, S, I>

pub fn new(
    key: S,
    name: String,
    friendly_name: String,
    description: String,
    cooldown: f64,
    passive: bool,
    conditions: Vec<StatCondition<K>>,
    item_conditions: Vec<(I, usize, UseMode)>,
    stat_effectors: Vec<E>
) -> Self

Constructs a new SkillDefinition.

impl<K: Hash + Eq + Debug, E, S, I: Hash + Eq + Clone + PartialEq + Debug> SkillDefinition<K, E, S, I>

Generics

K: Stat Key E: Effector Key S: Skill Key I: Item Key IT: Item Type CD: Item Custom Data

pub fn check_conditions<IT: SlotType, CD: PartialEq + Default + Clone + Debug>(
    &self,
    stats: &StatSet<K>,
    inventory: &Inventory<I, IT, CD>,
    stat_defs: &StatDefinitions<K>
) -> bool

Checks if all the conditions to use this skill are met.

Trait Implementations

impl<K: Clone, E: Clone, S: Clone, I: Clone> Clone for SkillDefinition<K, E, S, I>

fn clone(&self) -> SkillDefinition<K, E, S, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, E: Debug, S: Debug, I: Debug> Debug for SkillDefinition<K, E, S, I>

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

Formats the value using the given formatter.

impl<'de, K, E, S, I> Deserialize<'de> for SkillDefinition<K, E, S, I> where
    K: Deserialize<'de>,
    E: Deserialize<'de>,
    S: Deserialize<'de>,
    I: 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, E, S, I> Serialize for SkillDefinition<K, E, S, I> where
    K: Serialize,
    E: Serialize,
    S: Serialize,
    I: Serialize, 

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

Serialize this value into the given Serde serializer.