Send Custom Event
Sends a custom event, which will asynchronously trigger any ‘On Custom Event’ nodes which are listening for the same ‘Event Name’.
Installation
To use this node enable omni.graph.action_nodes in the Extension Manager.
Inputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Bundle (inputs:bundle) |
|
Bundle of data with information that is to be sent with the event. The payload for the event consists of a dictionary whose keys are the names of the attributes in this bundle and whose values are the values of the named attribute in Python pickled format. Optionally the value of the ‘Path’ attribute is also added to the payload. |
None |
Event Name (inputs:eventName) |
|
The name of the custom event to be sent out. |
|
Exec In (inputs:execIn) |
|
Signal to the graph that this node is ready to be executed. |
None |
Path (inputs:path) |
|
The path associated with the event. If specified, the path is added to the payload for the event under the dictionary key ‘!path’. |
Outputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Exec Out (outputs:execOut) |
|
Signal to the graph that execution can continue downstream. |
None |
Metadata
Name |
Value |
|---|---|
Unique ID |
omni.graph.action.SendCustomEvent |
Version |
2 |
Extension |
omni.graph.action_nodes |
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_nodes |