Input.KeyboardHandler

Description: Defines a handler that will check for keyboard commands and execute appropriate functions.

Implements: EndGate.IDisposable

Constructors

KeyboardHandler ()
Creates a new instance of the KeyboardHandler object.

Fields

OnKeyPress: EndGate.EventHandler1 <Input.KeyboardCommandEvent>
Gets an event that is triggered when any key press occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

OnKeyDown: EndGate.EventHandler1 <Input.KeyboardCommandEvent>
Gets an event that is triggered when any key goes down. Functions can be bound or unbound to this event to be executed when the event triggers.

OnKeyUp: EndGate.EventHandler1 <Input.KeyboardCommandEvent>
Gets an event that is triggered when any key comes up. Functions can be bound or unbound to this event to be executed when the event triggers.

Methods

OnCommandPress()
Binds function to be called when the keyCommand is pressed. To unbind the function, dispose of the returned KeyboardCommand.

OnCommandDown()
Binds function to be called when the keyCommand goes down. To unbind the function, dispose of the returned KeyboardCommand.

OnCommandUp()
Binds function to be called when the keyCommand comes up. To unbind the function, dispose of the returned KeyboardCommand.

Dispose()
Disposes the KeyboardHandler and unbinds all bound events.

Examples

There's currently no example available for this page. If you'd like to suggest one send me an containing a description, code, and link to the page for the suggested example. As a thanks I'll associate the code snippet with your name directly below the example if approved.