Broadcast Event in Ring
Description
Sends an event to all the components of an actor. It can be stopped when the event has been handled by a component, or left on to propagate the event to other components.
Technical Information
In: triggers the building block.
Handled: is activated when the event has been sent to all the components of the actor.
Not Handled: is activated when the event has not been handled.
EventDestination: is the actor to which the event should be sent.
Event: event to send. This parameter will only appear once the EventType setting has been set.
StopIfHandled: set to false if the event is to be sent to the other components of the ring even though it has already been handled by a first component, true otherwise. By default, the event is propagated to the other components. This parameter will only appear once the EventType setting has been set.
EventType: is the type of event to send, it can be changed via the building block settings.
Note
The broadcast is done over the actor’s component ring. An actor consists of an aggregation of components (the ring): when the building block is activated, the event is sent individually to each component in the ring. The event to send is specified through the Event input parameter, and its propagation controlled through the StopIfHandled input parameter.
Warning
The input parameter corresponding to the event to send as well as the input parameter controlling how the event is sent will only appear once the EventType setting has been set.
See Also
Send Event, Wait Event, An Introduction to Event System in 3DVIA Studio