.. _omni_graph_action_OnGamepadInput_1:

.. _omni_graph_action_OnGamepadInput:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: On Gamepad Input
    :keywords: lang-en omnigraph node graph:action,input:gamepad compute-on-request action on-gamepad-input


On Gamepad Input
================

.. <description>

Event node which fires when a gamepad event occurs. This node only capture events on buttons,  excluding triggers and sticks

.. </description>


Installation
------------

To use this node enable :ref:`omni.graph.action<ext_omni_graph_action>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Gamepad Element In (*inputs:gamepadElementIn*)", "``token``", "The gamepad button to trigger the downstream execution.", "Face Button Bottom"
    "", "*displayGroup*", "parameters", ""
    "", "*literalOnly*", "1", ""
    "", "*allowedTokens*", "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", ""
    "Gamepad ID (*inputs:gamepadId*)", "``uint``", "Gamepad id number starting from 0. Each gamepad will be registered automatically with an unique ID monotonically increasing in the order they are connected. If gamepad is disconnected, the ID assigned to the remaining gamepad will be adjusted accordingly so the IDs are always continues and start from 0 Change this value to a non-existing ID will result an error prompt in the console and the node will not listen to any gamepad input.", "0"
    "", "*literalOnly*", "1", ""
    "Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played.", "True"
    "", "*literalOnly*", "1", ""


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "outputs:isPressed", "``bool``", "True if the gamepad button was pressed, False if it was released", "None"
    "Pressed (*outputs:pressed*)", "``execution``", "Executes when gamepad element was pressed", "None"
    "Released (*outputs:released*)", "``execution``", "Executes when gamepad element was released", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.graph.action.OnGamepadInput"
    "Version", "1"
    "Extension", "omni.graph.action"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "tests"
    "uiName", "On Gamepad Input"
    "Categories", "graph:action,input:gamepad"
    "Generated Class Name", "OgnOnGamepadInputDatabase"
    "Python Module", "omni.graph.action"

