Struct cogs_gamedev::controls::EventInputHandler

pub struct EventInputHandler<I: Hash + Eq + PartialEq + Clone, C: Enum<u32> + Clone> { /* fields omitted */ }

Event-based input handler See module-level documentation for more detail.

Implementations

impl<I: Hash + Eq + PartialEq + Clone, C: Enum<u32> + Clone> EventInputHandler<I, C>

pub fn new_empty() -> Self

Create a new EventInputHandler without any controls.

pub fn new(control_config: HashMap<I, C>) -> Self

Create a new EventInputHandler with the specified controls. The HashMap in should map inputs to the controls you want them to actuate.

pub fn input_down(&mut self, input: I)

Call this function when your game engine gives you a KeyDown event, or any event signaling that an input is newly pressed down.

pub fn input_up(&mut self, input: I)

Call this function when your game engine gives you a KeyUp event, or any event signaling that an input has been released.

pub fn clear_inputs(&mut self)

Manually clear all the inputs the handler has received.

(I’m not sure why you would want to do this, but hey, might as well expose the functionality.)

pub fn update(&mut self)

Update the input handler. You MUST CALL THIS FIRST THING in your game loop. Otherwise things won’t get updated correctly.

Trait Implementations

impl<I: Hash + Eq + PartialEq + Clone, C: Enum<u32> + Clone> Clone for EventInputHandler<I, C>

EnumMap doesn’t implement Clone so we do it ourselves

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Hash + Eq + PartialEq + Clone, C: Enum<u32> + Clone> InputHandler<I, C> for EventInputHandler<I, C>

fn pressed(&self, control: C) -> bool

Is this input pressed down? i.e. is the player pressing the button?

fn released(&self, control: C) -> bool

Is this input released? i.e. is the player not pressing the button?

fn clicked_down(&self, control: C) -> bool

Is this input being clicked down? i.e. was it up last frame, but down this frame?