ProtoFlux:Async Dynamic Impulse Trigger With Data: Difference between revisions

VisualWikitext

Latest revision as of 21:49, 13 December 2024

Async Dynamic Impulse Trigger With Data

*

TriggeredCount

TargetHierarchy

ExcludeDisabled

Value

Async

The Async Dynamic Impulse Trigger With Data node sends an async dynamic impulse to all Async Dynamic Impulse Receiver With Data nodes with a matching type and tag under the provided TargetHierarchy.

Inputs

* (AsyncCall)

Trigger an async dynamic impulse with the tag Tag and data Value 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.

Value (Generic)

The data to send with the dynamic impulse. Receivers must have a matching type as this value.

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.

@@ Line 1: / Line 1: @@
 {{#Invoke:ProtoFlux|GenerateUI
-|Name=ASync Dynamic Impulse Trigger With Data
+|Name=Async Dynamic Impulse Trigger With Data
-|Category=ASync
+|Category=Async
 |Inputs=
 [
@@ Line 17: / Line 17: @@
 |}}
-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 With Data''' node sends an [[async]] [[dynamic impulse]] to all [[ProtoFlux:Async Dynamic Impulse Receiver With Data|Async Dynamic Impulse Receiver With Data]] nodes with a matching type and tag under the provided <code>TargetHierarchy</code>.
 == Inputs ==
 === * ([[Impulses|AsyncCall]])===
-Trigger the input slot TargetHierarchy ([[Slot|Slot]]) with the given Tag ([[Type:String|String]]) and Value (Generic).
+Trigger an async dynamic impulse with the tag <code>Tag</code> and data <code>Value</code> under <code>TargetHierarchy</code>.
 === 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]]) ===
-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]]) ===
-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.
 === Value (Generic) ===
-Value to send with this impulse.
+The data to send with the dynamic impulse. Receivers must have a matching type as this value.
 == Outputs ==
@@ Line 45: / Line 45: @@
 === Next ([[Impulses|Continuation]]) ===
-Code to run after all the code ran by the eligible ASync 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 ProtoFlux context.
-[[Category:ProtoFlux:Flow]]
+== See Also ==
+* [[ProtoFlux:Async Dynamic Impulse Trigger]] if data does not need to be sent.
+* [[ProtoFlux:Dynamic Impulse Trigger With Data]] for the sync context analogue.
+[[Category:ProtoFlux:Flow:Async]]