Struct Input 

pub struct Input {
    pub mouse_delta: Vec2,
    pub scroll: f32,
    pub canvas: Canvas,
    /* private fields */
}

Input snapshot, editable action bindings and shell requests.

Interior mutability permits shared script access to bindings and the HUD. Do not hold a Self::hud borrow while calling another HUD operation.

Fields

mouse_delta: Vec2

Pointer movement accumulated by the shell for this frame, in shell units.

scroll: f32

Vertical wheel movement for this frame, in shell units.

canvas: Canvas

Screen interface drawn by scripts this frame.

Implementations

impl Input

pub fn key_down(&self, k: Key) -> bool

Whether a key is held in the current snapshot.

pub fn key_pressed(&self, k: Key) -> bool

True only on the frame the key went down.

pub fn key_released(&self, k: Key) -> bool

True only in the snapshot where a previously held key was released.

pub fn mouse_down(&self, b: MouseButton) -> bool

Whether a pointer button is currently held.

pub fn mouse_pressed(&self, b: MouseButton) -> bool

True only in the snapshot where a pointer button went down.

pub fn mouse_released(&self, b: MouseButton) -> bool

True only in the snapshot where a pointer button was released.

pub fn lock_cursor(&self, lock: bool)

Scripts ask the shell to hide the cursor and keep it centred (mouse look).

pub fn cursor_locked(&self) -> bool

Current cursor-lock request; the hosting shell is responsible for applying it.

pub fn request_scene(&self, request: SceneRequest)

Asks the host to change scenes after this frame. A later request in the same frame wins.

pub fn take_scene_request(&self) -> Option<SceneRequest>

Takes the pending scene change, if any (hosts call this after each tick).

pub fn scene_path(&self) -> String

Asset path of the running scene (empty when the host did not say).

pub fn set_scene_path(&self, path: &str)

Records the asset path of the running scene (hosts call this).

pub fn set_storage(&self, storage: Storage)

Sets the game’s data folder (hosts call this once).

pub fn storage(&self) -> Storage

The game’s data folder.

pub fn request_quit(&self)

Asks the host to close the game.

pub fn quit_requested(&self) -> bool

Whether a script asked to quit (hosts poll this).

pub fn request_fullscreen(&self, on: bool)

Asks the host to switch fullscreen on or off.

pub fn take_fullscreen_request(&self) -> Option<bool>

Takes a pending fullscreen request (hosts poll this).

pub fn hud(&self) -> RefMut<'_, Hud>

Mutably borrows shell HUD state.

Panics

Panics if another HUD borrow is still held.

pub fn begin_frame(&self, dt: f32)

Called by the game loop every frame before scripts run.

pub fn axis(&self, minus: Key, plus: Key) -> f32

Axis from two keys: +1 when plus is held, -1 when minus is held.

pub fn action_down(&self, name: &str) -> bool

True while any input bound to the action is held.

pub fn action_pressed(&self, name: &str) -> bool

True on the frame an input bound to the action went down.

pub fn action_released(&self, name: &str) -> bool

True when the last held source of an action is released. Releasing one alternative while another is held does not release the action. A press and release of different sources in the same snapshot keeps it active.

pub fn action_vector( &self, left: &str, right: &str, down: &str, up: &str, ) -> Vec2

Two-dimensional action vector, clamped to unit length to avoid faster diagonals. Positive X is right, positive Y is up; absent actions contribute zero.

pub fn has_action(&self, name: &str) -> bool

Whether an action exists, including actions with no sources.

pub fn remove_action(&self, name: &str) -> bool

Removes an action, returning whether it existed.

pub fn try_rebind(&self, name: &str, sources: &[&str]) -> Result<(), String>

Validates all input names before replacing a binding.

Returns the first invalid name without changing existing bindings. Unlike Self::rebind, this catches configuration typos.

pub fn action_axis(&self, negative: &str, positive: &str) -> f32

-1..1 from two actions, e.g. action_axis("MoveLeft", "MoveRight").

pub fn rebind(&self, name: &str, sources: &[&str])

Replaces (or creates) an action’s bindings. Unknown names are ignored.

pub fn bindings(&self) -> Vec<(String, Vec<&'static str>)>

Current bindings as (action, input names).

pub fn set_bindings<S: AsRef<str>>(&self, defs: &[(String, Vec<S>)])

Replaces all actions. Duplicate action names use the last definition; unknown physical input names are ignored as in Self::rebind.

pub fn update( &mut self, keys: HashSet<Key>, buttons: HashSet<MouseButton>, mouse_delta: Vec2, scroll: f32, )

Call once per frame with the keys/buttons that are currently held.

pub fn reset(&mut self)

Clears held inputs, frame edges and pointer motion, and releases cursor lock. Bindings and HUD content are preserved. No synthetic release edges are emitted.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Input

fn default() -> Input

Returns the “default value” for a type.