Generate User Event
- Updated2023-02-17
- 2 minute(s) read
Generate User Event
Broadcasts the user event you wire to this node and associated event data to each Event Structure registered to handle the event.
If the event is not registered, this node has no effect.
Inputs/Outputs
user event
User event refnum created by a Create User Event node.
event data
The data associated with an event. The data type of the event data input must match the data type of the user event data type input on the Create User Event node. For example, if the data type of the user event data type input is a string, the data type of the event data input must also be a string.
priority
Value that defines how this node enqueues the user event.
| high priority | Enqueues the user event and associated event data into the event queue in front of any previously generated normal priority events. |
| normal priority | Enqueues the user event and associated event data into the event queue behind any previously generated events. |
Default value: (0) high priority
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
user event out
The resulting user event reference.
error out
Error information.
The node produces this output according to standard error behavior.