From 4bc6d9a6dc9ecb50cacf582ea6a243ad1a59c345 Mon Sep 17 00:00:00 2001 From: Sam Date: Fri, 28 Jul 2023 22:24:07 -0400 Subject: [PATCH] Added documentation --- assets/common/abilities/ability_set_manifest.ron | 2 +- common/src/comp/stats.rs | 5 +++-- common/src/states/self_buff.rs | 2 ++ 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/assets/common/abilities/ability_set_manifest.ron b/assets/common/abilities/ability_set_manifest.ron index 79e44b6ae7..0bd8e552c9 100644 --- a/assets/common/abilities/ability_set_manifest.ron +++ b/assets/common/abilities/ability_set_manifest.ron @@ -6,7 +6,7 @@ guard: Some(Contextualized( pseudo_id: "veloren.core.pseudo_abilities.sword.guard", abilities: [ - ([Stance(Sword(Defensive))], (None, "common.abilities.sword.defensive_guard")), + ((stance: Sword(Defensive)), (None, "common.abilities.sword.defensive_guard")), ([], (None, "common.abilities.sword.basic_guard")), ], )), diff --git a/common/src/comp/stats.rs b/common/src/comp/stats.rs index 159c296173..e8db7aa7aa 100644 --- a/common/src/comp/stats.rs +++ b/common/src/comp/stats.rs @@ -65,11 +65,12 @@ pub struct Stats { pub attack_damage_modifier: f32, pub crit_chance_modifier: StatsModifier, pub swim_speed_modifier: f32, - // This adds effects to any attacks that the entity makes + /// This adds effects to any attacks that the entity makes pub effects_on_attack: Vec, + /// This is the fraction of damage reduction (from armor and other buffs) that gets ignored by attacks from this entity pub mitigations_penetration: f32, pub energy_reward_modifier: f32, - // This creates effects when the entity is damaged + /// This creates effects when the entity is damaged pub effects_on_damaged: Vec, } diff --git a/common/src/states/self_buff.rs b/common/src/states/self_buff.rs index f5c2aa4aac..94559d0ab6 100644 --- a/common/src/states/self_buff.rs +++ b/common/src/states/self_buff.rs @@ -29,8 +29,10 @@ pub struct StaticData { pub buff_strength: f32, /// How long buff lasts pub buff_duration: Option, + /// This is the minimum amount of combo required to enter this character state pub combo_cost: u32, pub combo_scaling: Option, + /// This is the amount of combo held by the entity when this character state was entered pub combo_on_use: u32, /// What key is used to press ability pub ability_info: AbilityInfo,