1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// InputKey-to-action binding schema.
use crate::{AssetId, de_opt_asset_ref};
use alloc::string::String;
/// Maps a keyboard key to an action string.
///
/// When the bound key is pressed, the action fires once per press (like a
/// [HitRegion](#hitregion) click). Bindings only run while the cursor is free:
/// they're inactive in worlds that capture the cursor for camera control.
/// While a [TextInput](#textinput) has keyboard focus, bindings are suspended
/// so typing cannot trigger actions; a [Screen](#screen)'s `toggle_key` stays
/// live.
///
/// The action vocabulary is the same as [HitRegion](#hitregion)'s:
/// - `"scene:<name>"`: jump to the named [Scene](#scene)
/// - `"quit"`: stop the application
/// - `"screen:show:<name>"`: show the named [Screen](#screen), replacing the top of the stack
/// - `"screen:push:<name>"`: open the named [Screen](#screen) on top of what is showing
/// - `"screen:hide"`: close the top [Screen](#screen)
/// - `"screen:toggle:<name>"`: toggle the named [Screen](#screen)
///
/// InputKey names are case-sensitive canonical names (e.g. `"Escape"`, `"Space"`,
/// `"Enter"`).
///
/// ```rust
/// # use concinnity_asset::KeyBinding;
/// KeyBinding {
/// key: "Escape".into(),
/// action: "screen:toggle:pause_menu".into(),
/// ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
#[serde(default)]
pub struct KeyBinding {
/// The key name to bind (e.g. `"Escape"`).
pub key: String,
/// The action to fire when the key is pressed.
pub action: String,
/// [Screen](#screen) this binding is scoped to: the binding only fires
/// while that screen is on top of the stack. Unset, the binding is global.
#[serde(deserialize_with = "de_opt_asset_ref")]
pub screen: Option<AssetId>,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_binding_with_no_screen_is_global() {
let b = KeyBinding::default();
assert!(b.key.is_empty());
assert!(b.action.is_empty());
assert!(b.screen.is_none());
}
#[test]
fn a_screen_scoped_binding_parses_and_round_trips_through_postcard() {
crate::test_support::install_resolvers();
let b: KeyBinding =
serde_json::from_str(r#"{"key":"Escape","action":"back","screen":"menu"}"#).unwrap();
assert_eq!(b.key, "Escape");
assert_eq!(b.action, "back");
assert_eq!(b.screen, Some(AssetId(4)));
let bytes = postcard::to_allocvec(&b).unwrap();
let back: KeyBinding = postcard::from_bytes(&bytes).unwrap();
assert_eq!(back.key, "Escape");
assert_eq!(back.screen, Some(AssetId(4)));
}
}