OmniGraph Node omni.graph.action.OnCustomEvent¶
omni.graph.action.OnCustomEvent Properties¶
Name |
Value |
---|---|
Version |
2 |
Extension |
omni.graph.action |
Has State? |
True |
Implementation Language |
Python |
Default Memory Type |
cpu |
Generated Code Exclusions |
None |
uiName |
On Custom Event |
__categories |
graph:action,event |
__language |
Python |
Generated Class Name |
OgnOnCustomEventDatabase |
Python Module |
omni.graph.action |
omni.graph.action.OnCustomEvent Description¶
Event node which fires when the specified custom event is sent. This node is used in combination with SendCustomEvent
omni.graph.action.OnCustomEvent Inputs¶
Name |
Type |
Default |
Required? |
Descripton |
---|---|---|---|---|
inputs:eventName |
token |
Y |
The name of the custom event |
|
literalOnly |
1 |
|||
uiName |
Event Name |
|||
inputs:onlyPlayback |
bool |
True |
Y |
When true, the node is only computed while Stage is being played. |
literalOnly |
1 |
|||
uiName |
Only Simulate On Play |
|||
__default |
true |
omni.graph.action.OnCustomEvent Outputs¶
Name |
Type |
Default |
Required? |
Descripton |
---|---|---|---|---|
outputs:bundle |
bundle |
None |
Y |
Bundle received with the event |
uiName |
Bundle |
|||
outputs:execOut |
execution |
None |
Y |
Executes when the event is received |
uiName |
Received |
|||
outputs:path |
token |
None |
Y |
The path associated with the received custom event |
uiName |
Path |