OmniGraph Node omni.graph.action.OnKeyboardInput

omni.graph.action.OnKeyboardInput Properties

Name	Value
Version	3
Extension	omni.graph.action
Has State?	False
Implementation Language	C++
Default Memory Type	cpu
Generated Code Exclusions	None
uiName	On Keyboard Input
__categories	graph:action,input:keyboard
Generated Class Name	OgnOnKeyboardInputDatabase
Python Module	omni.graph.action

omni.graph.action.OnKeyboardInput Description

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.

omni.graph.action.OnKeyboardInput Inputs

Name	Type	Default	Required?	Descripton
inputs:altIn	bool	False	Y	When true, the node will check with a key modifier Alt
	literalOnly	1
	uiName	Alt
inputs:ctrlIn	bool	False	Y	When true, the node will check with a key modifier Control
	literalOnly	1
	uiName	Ctrl
inputs:keyIn	token	A	Y	The key to trigger the downstream execution
	displayGroup	parameters
	literalOnly	1
	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 In
	__default	“A”
inputs:onlyPlayback	bool	True	Y	When true, the node is only computed while Stage is being played.
	literalOnly	1
	uiName	Only Simulate On Play
	__default	true
inputs:shiftIn	bool	False	Y	When true, the node will check with a key modifier Shift
	literalOnly	1
	uiName	Shift

omni.graph.action.OnKeyboardInput Outputs

Name	Type	Default	Required?	Descripton
outputs:isPressed	bool	None	Y	True if the key was pressed, False if it was released
outputs:keyOut	token	None	Y	The key that was pressed or released
	uiName	Key Out
outputs:pressed	execution	None	Y	Executes when key was pressed
	uiName	Pressed
outputs:released	execution	None	Y	Executes when key was released
	uiName	Released