Added UseItem character state.

common/src/comp/character_state.rs

@@ -105,6 +105,8 @@ pub enum CharacterState {
     SelfBuff(self_buff::Data),
     /// Creates sprites around the caster
     SpriteSummon(sprite_summon::Data),
+    /// Handles logic for using an item so it is not simply instant
+    UseItem(use_item::Data),
 }
 
 impl CharacterState {

common/src/states/mod.rs

@@ -29,5 +29,6 @@ pub mod spin_melee;
 pub mod sprite_summon;
 pub mod stunned;
 pub mod talk;
+pub mod use_item;
 pub mod utils;
 pub mod wielding;

common/src/states/use_item.rs

@@ -0,0 +1,123 @@
+use super::utils::*;
+use crate::{
+    comp::{
+        inventory::{
+            item::{ConsumableKind, ItemKind},
+            slot::Slot,
+        },
+        CharacterState, StateUpdate,
+    },
+    states::behavior::{CharacterBehavior, JoinData},
+};
+use serde::{Deserialize, Serialize};
+use std::time::Duration;
+
+/// Separated out to condense update portions of character state
+#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
+pub struct StaticData {
+    /// Buildup to item use
+    pub buildup_duration: Duration,
+    /// Duration of item use
+    pub use_duration: Duration,
+    /// Recovery after item use
+    pub recover_duration: Duration,
+    /// Inventory slot to use item from
+    pub inv_slot: Slot,
+    /// Kind of item used
+    pub item_kind: ItemUseKind,
+}
+
+#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
+pub struct Data {
+    /// Struct containing data that does not change over the course of the
+    /// character state
+    pub static_data: StaticData,
+    /// Timer for each stage
+    pub timer: Duration,
+    /// What section the character stage is in
+    pub stage_section: StageSection,
+    /// Had weapon
+    pub was_wielded: bool,
+    /// Was sneaking
+    pub was_sneak: bool,
+}
+
+impl CharacterBehavior for Data {
+    fn behavior(&self, data: &JoinData) -> StateUpdate {
+        let mut update = StateUpdate::from(data);
+
+        match self.stage_section {
+            StageSection::Buildup => {
+                if self.timer < self.static_data.buildup_duration {
+                    // Build up
+                    update.character = CharacterState::UseItem(Data {
+                        timer: tick_attack_or_default(data, self.timer, None),
+                        ..*self
+                    });
+                } else {
+                    // Transitions to use section of stage
+                    update.character = CharacterState::UseItem(Data {
+                        timer: Duration::default(),
+                        stage_section: StageSection::Use,
+                        ..*self
+                    });
+                }
+            },
+            StageSection::Use => {
+                if self.timer < self.static_data.use_duration {
+                    // Item use
+                    update.character = CharacterState::UseItem(Data {
+                        timer: tick_attack_or_default(data, self.timer, None),
+                        ..*self
+                    });
+                } else {
+                    // Transitions to recover section of stage
+                    update.character = CharacterState::UseItem(Data {
+                        timer: Duration::default(),
+                        stage_section: StageSection::Recover,
+                        ..*self
+                    });
+                }
+            },
+            StageSection::Recover => {
+                if self.timer < self.static_data.recover_duration {
+                    // Recovery
+                    update.character = CharacterState::UseItem(Data {
+                        timer: tick_attack_or_default(data, self.timer, None),
+                        ..*self
+                    });
+                } else {
+                    // Done
+                    if self.was_wielded {
+                        update.character = CharacterState::Wielding;
+                    } else if self.was_sneak {
+                        update.character = CharacterState::Sneak;
+                    } else {
+                        update.character = CharacterState::Idle;
+                    }
+                }
+            },
+            _ => {
+                // If it somehow ends up in an incorrect stage section
+                update.character = CharacterState::Idle;
+            },
+        }
+
+        update
+    }
+}
+
+/// Used to control effects based off of the type of item used
+#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
+pub enum ItemUseKind {
+    Consumable(ConsumableKind),
+}
+
+impl From<&ItemKind> for Option<ItemUseKind> {
+    fn from(item_kind: &ItemKind) -> Self {
+        match item_kind {
+            ItemKind::Consumable { kind, .. } => Some(ItemUseKind::Consumable(*kind)),
+            _ => None,
+        }
+    }
+}

common/src/states/utils.rs

@@ -836,12 +836,15 @@ pub fn tick_attack_or_default(
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
 pub enum StageSection {
     Buildup,
-    Swing,
     Recover,
     Charge,
-    Cast,
-    Shoot,
     Movement,
+    // TODO: Consolidate these to `Action`
+    // Code reviewers: comment here to remind me to open beginner issue
+    Swing,
+    Shoot,
+    Cast,
+    Use,
 }
 
 #[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]

common/systems/src/character_behavior.rs

@@ -332,6 +332,7 @@ impl<'a> System<'a> for Sys {
                     CharacterState::BasicSummon(data) => data.handle_event(&j, action),
                     CharacterState::SelfBuff(data) => data.handle_event(&j, action),
                     CharacterState::SpriteSummon(data) => data.handle_event(&j, action),
+                    CharacterState::UseItem(data) => data.handle_event(&j, action),
                 };
                 local_emitter.append(&mut state_update.local_events);
                 server_emitter.append(&mut state_update.server_events);
@@ -388,6 +389,7 @@ impl<'a> System<'a> for Sys {
                 CharacterState::BasicSummon(data) => data.behavior(&j),
                 CharacterState::SelfBuff(data) => data.behavior(&j),
                 CharacterState::SpriteSummon(data) => data.behavior(&j),
+                CharacterState::UseItem(data) => data.behavior(&j),
             };
 
             local_emitter.append(&mut state_update.local_events);

common/systems/src/stats.rs

@@ -289,7 +289,8 @@ impl<'a> System<'a> for Sys {
                 CharacterState::Roll { .. }
                 | CharacterState::Climb { .. }
                 | CharacterState::Stunned { .. }
-                | CharacterState::BasicBlock { .. } => {},
+                | CharacterState::BasicBlock { .. }
+                | CharacterState::UseItem { .. } => {},
             }
         }