ProtoFlux:Async Dynamic Impulse Trigger: Difference between revisions

From Resonite Wiki
Create ASync Dynamic Impulse Trigger ProtoFlux Node Page
 
cleanup
Line 1: Line 1:
{{#Invoke:ProtoFlux|GenerateUI
{{#Invoke:ProtoFlux|GenerateUI
|Name=ASyncs Dynamic Impulse Trigger
|Name=Asyncs Dynamic Impulse Trigger
|Category=Async
|Category=Async
|Inputs=
|Inputs=
Line 16: Line 16:
|}}
|}}


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


== Inputs ==
== Inputs ==


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


Trigger the input slot TargetHierarchy ([[Slot|Slot]]) with the given Tag ([[Type:String|String]]).
Trigger a 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|AsyncCall]]).
The tag of the dynamic impulse.


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


The [[Slot|Slot]] under which to trigger eligible ASync 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 async 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 ASync dynamic impulse receivers is done running.
Triggered once the context of every receiver is completed.


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


Number of ASync Dynamic Impulse Receivers that were eligible and got triggered.
Number of receivers that were triggered. Only exists for the current ProtoFlux [[context]].


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

Revision as of 17:54, 12 December 2024

Asyncs Dynamic Impulse Trigger
*
Next
Tag
TriggeredCount
TargetHierarchy
ExcludeDisabled
Async

The Async Dynamic Impulse Trigger node sends a Dynamic Impulse to all Async Dynamic Impulse Receivers matching the provided Tag under the TargetHierarchy.

Inputs

* (AsyncCall)

Trigger a 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 ProtoFlux context.