.. _omni_graph_action_OnMessageBusEvent_1:

.. _omni_graph_action_OnMessageBusEvent:

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

:orphan:

.. meta::
    :title: On MessageBus Event
    :keywords: lang-en omnigraph node graph:action,event compute-on-request action on-message-bus-event


On MessageBus Event
===================

.. <description>

Event node which fires when the specified event is popped from the App Message Bus. Carb events can be sent with Python: msg = carb.events.type_from_string('my_event_name') omni.kit.app.get_app().get_message_bus_event_stream().push(msg, payload={'arg1': 42}) The event payload data will be copied in to matching dynamic output attributes if they exist. In the previous example, 42 would be copied to outputs:arg1 if possible

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

    "Event Name (*inputs:eventName*)", "``token``", "The name of the custom event", ""
    "", "*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

    "Received (*outputs:execOut*)", "``execution``", "Executes when the event is received", "None"


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

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

