Struct veloren_common::comp::skillset::SkillSet

pub struct SkillSet {
    skill_groups: HashMap<SkillGroupKind, SkillGroup>,
    skills: HashMap<Skill, u16>,
}

Contains all of a player’s skill groups and skills. Provides methods for manipulating assigned skills and skill groups including unlocking skills, refunding skills etc.

Fields

skill_groups: HashMap<SkillGroupKind, SkillGroup>

skills: HashMap<Skill, u16>

Implementations

impl SkillSet

pub fn initial_skills() -> HashMap<Skill, u16>

pub fn load_from_database( skill_groups: HashMap<SkillGroupKind, SkillGroup>, all_skills: HashMap<SkillGroupKind, Result<Vec<Skill>, SkillsPersistenceError>>, ) -> (Self, Option<SkillsPersistenceError>)

NOTE: This does not return an error on failure, since we can partially recover from some failures. Instead, it returns the error in the second return value; make sure to handle it if present!

fn skill_group_accessible_if_exists( &self, skill_group_kind: SkillGroupKind, ) -> bool

Check if a particular skill group is accessible for an entity, if it exists.

pub fn skill_group_accessible(&self, skill_group_kind: SkillGroupKind) -> bool

Checks if a particular skill group is accessible for an entity

fn unlock_skill_group(&mut self, skill_group_kind: SkillGroupKind)

Unlocks a skill group for a player. It starts with 0 exp and 0 skill points.

pub fn skill_groups(&self) -> impl Iterator<Item = &SkillGroup>

Returns an iterator over skill groups

fn skill_group(&self, skill_group: SkillGroupKind) -> Option<&SkillGroup>

Returns a reference to a particular skill group in a skillset

fn skill_group_mut( &mut self, skill_group: SkillGroupKind, ) -> Option<&mut SkillGroup>

Returns a mutable reference to a particular skill group in a skillset Requires that skillset contains skill that unlocks the skill group

pub fn add_experience( &mut self, skill_group_kind: SkillGroupKind, amount: u32, ) -> Option<u16>

Adds experience to the skill group within an entity’s skill set, will attempt to earn a skill point while doing so. If a skill point was earned, returns the number of earned skill points in the skill group.

pub fn available_experience(&self, skill_group: SkillGroupKind) -> u32

Gets the available experience for a particular skill group

pub fn skill_point_cost(&self, skill_group: SkillGroupKind) -> u32

Checks how much experience is needed for the next skill point in a tree

pub fn add_skill_points( &mut self, skill_group_kind: SkillGroupKind, number_of_skill_points: u16, )

Adds skill points to a skill group as long as the player has that skill group type.

pub fn available_sp(&self, skill_group: SkillGroupKind) -> u16

Gets the available points for a particular skill group

pub fn earned_sp(&self, skill_group: SkillGroupKind) -> u16

Gets the total earned points for a particular skill group

pub fn prerequisites_met(&self, skill: Skill) -> bool

Checks that the skill set contains all prerequisite skills of the required level for a particular skill

pub fn skill_cost(&self, skill: Skill) -> u16

Gets skill point cost to purchase skill of next level

pub fn sufficient_skill_points(&self, skill: Skill) -> bool

Checks if player has sufficient skill points to purchase a skill

fn next_skill_level(&self, skill: Skill) -> u16

Checks the next level of a skill

pub fn unlock_skill_cow<'a, B, C>( this_: &'a mut B, skill: Skill, to_mut: impl FnOnce(&'a mut B) -> &'a mut C, ) -> Result<(), SkillUnlockError>

where B: Borrow<SkillSet>, C: BorrowMut<SkillSet> + 'a,

Unlocks a skill for a player, assuming they have the relevant skill group unlocked and available SP in that skill group.

NOTE: Please don’t use pathological or clever implementations of to_mut here.

pub fn unlock_skill(&mut self, skill: Skill) -> Result<(), SkillUnlockError>

Convenience function for the case where you have mutable access to the skill.

pub fn has_available_sp(&self) -> bool

Checks if the player has available SP to spend

pub fn is_at_max_level(&self, skill: Skill) -> bool

Checks if the skill is at max level in a skill set

pub fn has_skill(&self, skill: Skill) -> bool

Checks if skill set contains a skill

pub fn skill_level(&self, skill: Skill) -> Result<u16, SkillError>

Returns the level of the skill

Trait Implementations

impl Clone for SkillSet

fn clone(&self) -> SkillSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for SkillSet

type Storage = DerefFlaggedStorage<SkillSet, VecStorage<SkillSet>>

Associated storage type for this component.

impl Debug for SkillSet

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

Formats the value using the given formatter.

impl Default for SkillSet

fn default() -> Self

Instantiate a new skill set with the default skill groups with no unlocked skills in them - used when adding a skill set to a new player

impl<'de> Deserialize<'de> for SkillSet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SkillSet

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SkillSet

impl StructuralPartialEq for SkillSet