lotus_shared/
action.rs

1//! Eingabeaktionen, die bei der Engine registriert werden, und zugehörige Nachrichtentypen.
2//!
3//! Input actions registered with the engine and related message types.
4
5use serde::{Deserialize, Serialize};
6use serde_repr::{Deserialize_repr, Serialize_repr};
7
8use crate::{
9    input::{ActionState, KeyCode},
10    message::{MessageMeta, MessageType},
11};
12
13/// Beschreibt eine Aktion, die bei der Engine registriert werden kann.
14///
15/// Describes an action that can be registered with the engine.
16#[derive(Debug, Clone, Serialize, Deserialize)]
17pub struct RegisterAction {
18    /// Eindeutige Aktions-ID für Scripts und das Content-Tool.
19    ///
20    /// Unique action identifier used by scripts and the content tool.
21    pub id: String,
22    /// Standard-Tastenbelegung bei der Registrierung der Aktion.
23    ///
24    /// Default key binding when the action is registered.
25    pub default_key: KeyCode,
26}
27
28impl RegisterAction {
29    /// Erstellt einen neuen Registrierungseintrag für eine Aktion.
30    ///
31    /// Creates a new action registration entry.
32    pub fn new(id: String, default_key: KeyCode) -> Self {
33        Self { id, default_key }
34    }
35}
36
37impl<T: Into<String>> From<(T, KeyCode)> for RegisterAction {
38    fn from((id, default_key): (T, KeyCode)) -> Self {
39        Self::new(id.into(), default_key)
40    }
41}
42
43/// Builder zum Sammeln von [`RegisterAction`]-Einträgen.
44///
45/// Builder for collecting [`RegisterAction`] entries.
46#[derive(Debug, Default, Clone, Serialize, Deserialize)]
47pub struct ActionsBuilder(Vec<RegisterAction>);
48
49impl ActionsBuilder {
50    /// Erstellt einen leeren Builder.
51    ///
52    /// Creates an empty builder.
53    pub fn new() -> Self {
54        Self::default()
55    }
56
57    /// Fügt eine Aktion mit der angegebenen ID und Standardtaste hinzu.
58    ///
59    /// Adds an action with the given id and default key.
60    pub fn push(mut self, id: impl Into<String>, default_key: KeyCode) -> Self {
61        self.0.push(RegisterAction::new(id.into(), default_key));
62        self
63    }
64
65    /// Gibt die gesammelten Aktionsregistrierungen zurück.
66    ///
67    /// Returns the collected action registrations.
68    pub fn build(self) -> Vec<RegisterAction> {
69        self.0
70    }
71}
72
73/// Beschreibt ein Ereignis, das ausgelöst wird, wenn eine Aktion betätigt wird.
74///
75/// Describes an event that is sent when an action is triggered.
76#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
77pub struct ActionEvent {
78    /// Name der ausgelösten Aktion.
79    ///
80    /// Name of the triggered action.
81    pub name: String,
82    /// Aktueller Eingabezustand der Aktion.
83    ///
84    /// Current input state of the action.
85    pub state: ActionState,
86}
87
88impl MessageType for ActionEvent {
89    const MESSAGE_META: MessageMeta = MessageMeta::new("builtin", "action_event", None);
90}
91
92/// Beschreibt die Art der ausgelösten Aktion.
93///
94/// Describes the kind of action that was triggered.
95#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize_repr, Deserialize_repr)]
96#[repr(u8)]
97pub enum ActionKind {
98    /// Die Aktion wurde gedrückt.
99    ///
100    /// The action was pressed.
101    Pressed = 1,
102    /// Die Aktion wurde losgelassen.
103    ///
104    /// The action was released.
105    Released = 2,
106}
lotus_shared/action.rs

lotus_shared/
action.rs
