.. _omni_graph_action_OnStageEvent_3:

.. _omni_graph_action_OnStageEvent:

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

:orphan:

.. meta::
    :title: On Stage Event
    :keywords: lang-en omnigraph node graph:action,event compute-on-request action on-stage-event


On Stage Event
==============

.. <description>

Executes when the specified Stage Event occurs. Stage Events are emitted when certain USD stage-related actions are performed by the system:
 Saved: USD file saved.
 Selection Changed: USD Prim selection has changed.
 Hierarchy Changed: USD stage hierarchy has changed, e.g. a prim is added, deleted or moved.
 OmniGraph Start Play: OmniGraph started
 OmniGraph Stop Play: OmniGraph stopped
 Simulation Start Play: Simulation started
 Simulation Stop Play: Simulation stopped
 Animation Start Play: Animation playback has started
 Animation Stop Play: Animation playback has stopped

.. </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

    "inputs:eventName", "``token``", "The event of interest", ""
    "", "*allowedTokens*", "Saved,Selection Changed,Hierarchy Changed,OmniGraph Start Play,OmniGraph Stop Play,Simulation Start Play,Simulation Stop Play,Animation Start Play,Animation Stop Play", ""
    "", "*default*", "Animation Start Play", ""
    "", "*displayGroup*", "parameters", ""
    "", "*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:execOut", "``execution``", "The execution output", "None"


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

    "Unique ID", "omni.graph.action.OnStageEvent"
    "Version", "3"
    "Extension", "omni.graph.action"
    "Has State?", "True"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "On Stage Event"
    "Categories", "graph:action,event"
    "Generated Class Name", "OgnOnStageEventDatabase"
    "Python Module", "omni.graph.action"

