OmniGraph Node omni.graph.nodes.ReadGamepadState

omni.graph.nodes.ReadGamepadState 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 Gamepad State

__categories

input:gamepad

Generated Class Name

OgnReadGamepadStateDatabase

Python Module

omni.graph.nodes

omni.graph.nodes.ReadGamepadState Description

Reads the current state of the gamepad

omni.graph.nodes.ReadGamepadState Inputs

Name

Type

Default

Required?

Descripton

inputs:deadzone

float

0.1

Y

Threshold from [0, 1] that the value must pass for it to be registered as input

uiName

Deadzone

__default

0.1

inputs:gamepadElement

token

Left Stick X Axis

Y

The gamepad element to check the state of

displayGroup

parameters

allowedTokens

Left Stick X Axis,Left Stick Y Axis,Right Stick X Axis,Right Stick Y Axis,Left Trigger,Right Trigger,Face Button Bottom,Face Button Right,Face Button Left,Face Button Top,Left Shoulder,Right Shoulder,Special Left,Special Right,Left Stick Button,Right Stick Button,D-Pad Up,D-Pad Right,D-Pad Down,D-Pad Left

__allowedTokens

{“LeftStickXAxis”: “Left Stick X Axis”, “LeftStickYAxis”: “Left Stick Y Axis”, “RightStickXAxis”: “Right Stick X Axis”, “RightStickYAxis”: “Right Stick Y Axis”, “LeftTrigger”: “Left Trigger”, “RightTrigger”: “Right Trigger”, “FaceButtonBottom”: “Face Button Bottom”, “FaceButtonRight”: “Face Button Right”, “FaceButtonLeft”: “Face Button Left”, “FaceButtonTop”: “Face Button Top”, “LeftShoulder”: “Left Shoulder”, “RightShoulder”: “Right Shoulder”, “SpecialLeft”: “Special Left”, “SpecialRight”: “Special Right”, “LeftStickButton”: “Left Stick Button”, “RightStickButton”: “Right Stick Button”, “DpadUp”: “D-Pad Up”, “DpadRight”: “D-Pad Right”, “DpadDown”: “D-Pad Down”, “DpadLeft”: “D-Pad Left”}

uiName

Element

__default

“Left Stick X Axis”

inputs:gamepadId

uint

0

Y

Gamepad id number starting from 0

uiName

Gamepad ID

__default

0

omni.graph.nodes.ReadGamepadState Outputs

Name

Type

Default

Required?

Descripton

outputs:isPressed

bool

None

Y

True if the gamepad element is currently pressed, false otherwise

outputs:value

float

None

Y

Value of how much the gamepad element is being pressed. [0, 1] for buttons [-1, 1] for stick and trigger