.. _omni_graph_action_SendCustomEvent_1:

.. _omni_graph_action_SendCustomEvent:

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

:orphan:

.. meta::
    :title: Send Custom Event
    :keywords: lang-en omnigraph node graph:action,event action send-custom-event


Send Custom Event
=================

.. <description>

Sends a custom event, which will asynchronously trigger any OnCustomEvent nodes which are listening for the same eventName

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

    "Bundle (*inputs:bundle*)", "``bundle``", "Bundle to be sent with the event", "None"
    "Event Name (*inputs:eventName*)", "``token``", "The name of the custom event", ""
    "inputs:execIn", "``execution``", "Input Execution", "None"
    "Path (*inputs:path*)", "``token``", "The path associated with the event", ""


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

    "outputs:execOut", "``execution``", "Output Execution", "None"


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

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

