On Keyboard Input#

Event node which fires when a keyboard event occurs. The event can be a combination of keys, containing key modifiers of ctrl, alt and shift, and a normal key of any key. keyIn. For key combinations, the press event requires all keys to be pressed, with the normal key pressed last. The release event is only triggered once when one of the chosen keys released after pressed event happens. For example: if the combination is ctrl-shift-D, the pressed event happens once right after D is pressed while both ctrl and shit are held. And the release event happens only once when the user releases any key of ctrl, shift and D while holding them.

Installation#

To use this Node, you must enable omni.graph.action in the Extension Manager.

Inputs#

Name

Type

Description

Default

Key In (keyIn)

token

The key to trigger the downstream execution

A

Only Simulate On Play (onlyPlayback)

bool

When true, the node is only computed while Stage is being played.

True

Shift (shiftIn)

bool

When true, the node will check with a key modifier Shift

Alt (altIn)

bool

When true, the node will check with a key modifier Alt

Ctrl (ctrlIn)

bool

When true, the node will check with a key modifier Control

Outputs#

Name

Type

Description

Default

Key Out (keyOut)

token

The key that was pressed or released

Pressed (pressed)

execution

Executes when key was pressed

Released (released)

execution

Executes when key was released

isPressed

bool

True if the key was pressed, False if it was released