OmniGraph Node omni.graph.nodes.ReadKeyboardState

omni.graph.nodes.ReadKeyboardState Properties

Name

Value

Version

1

Extension

omni.graph.nodes

Has State?

False

Implementation Language

C++

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

Read Keyboard State

__categories

input:keyboard

Generated Class Name

OgnReadKeyboardStateDatabase

Python Module

omni.graph.nodes

omni.graph.nodes.ReadKeyboardState Description

Reads the current state of the keyboard

omni.graph.nodes.ReadKeyboardState Inputs

Name

Type

Default

Required?

Descripton

inputs:key

token

A

Y

The key to check the state of

displayGroup

parameters

allowedTokens

A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,Apostrophe,Backslash,Backspace,CapsLock,Comma,Del,Down,End,Enter,Equal,Escape,F1,F10,F11,F12,F2,F3,F4,F5,F6,F7,F8,F9,GraveAccent,Home,Insert,Key0,Key1,Key2,Key3,Key4,Key5,Key6,Key7,Key8,Key9,Left,LeftAlt,LeftBracket,LeftControl,LeftShift,LeftSuper,Menu,Minus,NumLock,Numpad0,Numpad1,Numpad2,Numpad3,Numpad4,Numpad5,Numpad6,Numpad7,Numpad8,Numpad9,NumpadAdd,NumpadDel,NumpadDivide,NumpadEnter,NumpadEqual,NumpadMultiply,NumpadSubtract,PageDown,PageUp,Pause,Period,PrintScreen,Right,RightAlt,RightBracket,RightControl,RightShift,RightSuper,ScrollLock,Semicolon,Slash,Space,Tab,Up

__allowedTokens

[“A”, “B”, “C”, “D”, “E”, “F”, “G”, “H”, “I”, “J”, “K”, “L”, “M”, “N”, “O”, “P”, “Q”, “R”, “S”, “T”, “U”, “V”, “W”, “X”, “Y”, “Z”, “Apostrophe”, “Backslash”, “Backspace”, “CapsLock”, “Comma”, “Del”, “Down”, “End”, “Enter”, “Equal”, “Escape”, “F1”, “F10”, “F11”, “F12”, “F2”, “F3”, “F4”, “F5”, “F6”, “F7”, “F8”, “F9”, “GraveAccent”, “Home”, “Insert”, “Key0”, “Key1”, “Key2”, “Key3”, “Key4”, “Key5”, “Key6”, “Key7”, “Key8”, “Key9”, “Left”, “LeftAlt”, “LeftBracket”, “LeftControl”, “LeftShift”, “LeftSuper”, “Menu”, “Minus”, “NumLock”, “Numpad0”, “Numpad1”, “Numpad2”, “Numpad3”, “Numpad4”, “Numpad5”, “Numpad6”, “Numpad7”, “Numpad8”, “Numpad9”, “NumpadAdd”, “NumpadDel”, “NumpadDivide”, “NumpadEnter”, “NumpadEqual”, “NumpadMultiply”, “NumpadSubtract”, “PageDown”, “PageUp”, “Pause”, “Period”, “PrintScreen”, “Right”, “RightAlt”, “RightBracket”, “RightControl”, “RightShift”, “RightSuper”, “ScrollLock”, “Semicolon”, “Slash”, “Space”, “Tab”, “Up”]

uiName

Key

__default

“A”

omni.graph.nodes.ReadKeyboardState Outputs

Name

Type

Default

Required?

Descripton

outputs:altOut

bool

None

Y

True if Alt is held

uiName

Alt

outputs:ctrlOut

bool

None

Y

True if Ctrl is held

uiName

Ctrl

outputs:isPressed

bool

None

Y

True if the key is currently pressed, false otherwise

outputs:shiftOut

bool

None

Y

True if Shift is held

uiName

Shift