ProtoFlux:Dynamic Impulse Trigger: Difference between revisions

From Resonite Wiki
examples can go on dynamic impulses page
standardize
 
Line 16: Line 16:
|}}
|}}


Since Dynamic Impulses can be a complex topic, the usage of this node is part of the [[Dynamic Impulses]] page.
The '''Dynamic Impulse Trigger''' node sends a [[sync context]] [[dynamic impulse]] to all [[ProtoFlux:Dynamic Impulse Receiver|Dynamic Impulse Receivers]] matching the provided <code>Tag</code> under the <code>TargetHierarchy</code>.


== Inputs ==
== Inputs ==


=== * ([[Impulses|Call]]) ===  
=== * ([[Impulses|Call]]) ===


Trigger the input slot TargetHierarchy ([[Slot|Slot]]) with the given Tag ([[Type:String|String]]).
Trigger a sync context dynamic impulse with the tag <code>Tag</code> under <code>TargetHierarchy</code>.


=== Tag ([[Type:String|String]]) ===
=== Tag ([[Type:String|String]]) ===


The tag of the Dynamic Impulse that should be sent after calling * ([[Impulses|Call]]).
The tag of the dynamic impulse.


=== TargetHierarchy ([[Slot|Slot]]) ===
=== TargetHierarchy ([[Slot|Slot]]) ===


The [[Slot|Slot]] under which to trigger eligible Dynamic Impulse Recievers.
The slot under which to search for dynamic impulse receivers.


=== ExcludeDisabled ([[Type:Bool|bool]]) ===
=== ExcludeDisabled ([[Type:Bool|bool]]) ===


Decides if this node should or should not activate eligible dynamic receivers that are under disabled hierarchy.
If <code>True</code>, the dynamic impulse will not search for receivers under disabled slots.


== Outputs ==
== Outputs ==
Line 40: Line 40:
=== Next ([[Impulses|Continuation]]) ===
=== Next ([[Impulses|Continuation]]) ===


Code to run after all the code ran by the eligible dynamic impulse receivers is done running, excluding a-syncs created by the receivers.
Triggered once the [[context]] of every receiver is completed.


=== TriggeredCount ([[Types:Int|Int]])===  
=== TriggeredCount ([[Types:Int|Int]]) ===


Number of Dynamic Impulse Receivers that were eligible and got triggered.
Number of receivers that were triggered. Only exists for the current context.
 
== See Also ==
 
* [[ProtoFlux:Dynamic Impulse Trigger With Data]] to send data with the impulse.
* [[ProtoFlux:Async Dynamic Impulse Trigger]] for the async analogue.


[[Category:ProtoFlux:Flow]]
[[Category:ProtoFlux:Flow]]

Latest revision as of 21:38, 13 December 2024

Dynamic Impulse Trigger
*
Next
Tag
TriggeredCount
TargetHierarchy
ExcludeDisabled
Flow

The Dynamic Impulse Trigger node sends a sync context dynamic impulse to all Dynamic Impulse Receivers matching the provided Tag under the TargetHierarchy.

Inputs

* (Call)

Trigger a sync context dynamic impulse with the tag Tag under TargetHierarchy.

Tag (String)

The tag of the dynamic impulse.

TargetHierarchy (Slot)

The slot under which to search for dynamic impulse receivers.

ExcludeDisabled (bool)

If True, the dynamic impulse will not search for receivers under disabled slots.

Outputs

Next (Continuation)

Triggered once the context of every receiver is completed.

TriggeredCount (Int)

Number of receivers that were triggered. Only exists for the current context.

See Also