On Custom Event
Event node which fires when the specified custom event is sent. This node is used in combination with ‘omni.graph.action.SendCustomEvent’.
Installation
To use this node enable omni.graph.action_nodes in the Extension Manager.
Inputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Event Name (inputs:eventName) |
|
The name of the custom event. |
|
Metadata |
literalOnly = 1 |
||
Only Simulate On Play (inputs:onlyPlayback) |
|
When true, the node is only executed while the Stage is being played. |
True |
Metadata |
literalOnly = 1 |
Outputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Bundle (outputs:bundle) |
|
Bundle received with the event. The contents of the bundle are determined by the input bundle given to the corresponding ‘SendCustomEvent’ node. |
None |
Received (outputs:execOut) |
|
When the custom event was received signal to the graph that execution can continue downstream. |
None |
Path (outputs:path) |
|
The path associated with the received custom event |
None |
Metadata
Name |
Value |
|---|---|
Unique ID |
omni.graph.action.OnCustomEvent |
Version |
3 |
Extension |
omni.graph.action_nodes |
Has State? |
True |
Implementation Language |
Python |
Default Memory Type |
cpu |
Generated Code Exclusions |
None |
uiName |
On Custom Event |
Categories |
graph:action,event |
Generated Class Name |
OgnOnCustomEventDatabase |
Python Module |
omni.graph.action_nodes |