Keyboard Input Object

From Runic Games Wiki
Jump to: navigation, search

Contents

Keyboard Input

Description

This Level Object is used to monitor a specific key on the keyboard and fire an Output event when the key is pressed.

Location

Right-click on an empty space in the Layout Scene Manager and choose Logic > Keyboard Input from the list.

Properties

Name Type Description Read Only
PROPERTIES
ENABLED
bool
Set the Keyboard Input object enabled or disabled.
IGNORE UI
bool
If True the Keyboard Input will ignore any UI that is capturing input.
KEYS
string
Set the keyboard key(s) to watch for. Letters must be capitalized.
UI PROPERTIES
KEY BINDING
string
The key binding to watch for. The Keyboard Input will watch for the specific event instead of a specific key press.

Input Events

Enable
Enable the Keyboard Input object. "Key Down", "Key Up", "Shift Down", "Control Down", and "Esc Down" Output events will fire.
Disable
Disable the Keyboard Input object. "Key Down", "Key Up", "Shift Down", "Control Down", and "Esc Down" Output events will not fire.
Reset
Reset the Keyboard Input object.

Output Events

Enabled
This event will fire when the Keyboard Input receives an "Enable" Input event.
Disabled
This event will fire when the Keyboard Input receives a "Disable" Input event.
KEY DOWN
This event will fire when the specified "Keys" are pressed down.
KEY UP
This event will fire when the specified "Keys" are let up.
Shift Down
This event will fire when the "Shift" key is pressed down.
Control Down
This event will fire when the "Ctrl" key is pressed down.
Esc Down
This event will fire when the "Esc" key is pressed down.
Personal tools
Namespaces

Variants
Actions
Navigation
Runic Sites
Toolbox