add info, example, how it works |
clean |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 10: | Line 10: | ||
|Outputs= | |Outputs= | ||
[ | [ | ||
{"Name": "LoopStart", "Type":" | {"Name": "LoopStart", "Type":"AsyncCall"}, | ||
{"Name": "LoopIteration", "Type":" | {"Name": "LoopIteration", "Type":"AsyncCall"}, | ||
{"Name": "LoopEnd", "Type":"Continuation"}, | {"Name": "LoopEnd", "Type":"Continuation"}, | ||
{"Name": "Iteration", "Type":"int"} | {"Name": "Iteration", "Type":"int"} | ||
| Line 17: | Line 17: | ||
|}} | |}} | ||
The '''Async For''' node is used to perform looping operations by allowing one to fire impulses a set amount of times. It is the [[async]] variant of the [[ProtoFlux:For|For]] node. | |||
== Inputs == | == Inputs == | ||
=== * === | === * ([[Impulses#ASync|IAsyncOperation]]) === | ||
Begin the for loop. | |||
=== Count ([[Type:Int|int]]) === | === Count ([[Type:Int|int]]) === | ||
The amount of times to trigger <code>LoopIteration</code>. Will not trigger any iterations if less than 1. | |||
=== Reverse ([[Type:Bool|bool]]) === | === Reverse ([[Type:Bool|bool]]) === | ||
If <code>True</code>, the <code>Iteration</code> output will start at <code>Count - 1</code> and go down towards <code>0</code>. | |||
== Outputs == | == Outputs == | ||
=== LoopStart ([[Impulses#ASync| | === LoopStart ([[Impulses#ASync|AsyncCall]]) === | ||
Fires after <code>*</code> is pulsed and before any iterations are done. Will be pulsed even if <code>Count < 1</code>. | |||
=== LoopIteration ([[Impulses#ASync|AsyncCall]]) === | |||
Fires for each iteration of the loop. This impulse is triggered <code>Count</code> amount of times and the next iteration will only be fired once the current iteration's [[context]] is finished. | |||
=== LoopEnd ([[Impulses|Continuation]]) === | === LoopEnd ([[Impulses|Continuation]]) === | ||
Fires | Fires after the final <code>LoopIteration</code> completes execution. | ||
=== Iteration ([[Type:Int|int]]) === | === Iteration ([[Type:Int|int]]) === | ||
For each <code>LoopIteration</code>, this output is set to be the index of the iteration for said iteration's context. By default, this will start at <code>0</code> and increment until <code>Count - 1</code> unless <code>Reverse</code> is <code>True</code>. | |||
== Examples == | == Examples == | ||
[[Category:ProtoFlux:Flow:Async]] | [[Category:ProtoFlux:Flow:Async]] | ||
Latest revision as of 21:51, 13 December 2024
Async For
Async
The Async For node is used to perform looping operations by allowing one to fire impulses a set amount of times. It is the async variant of the For node.
Inputs
* (IAsyncOperation)
Begin the for loop.
Count (int)
The amount of times to trigger LoopIteration. Will not trigger any iterations if less than 1.
Reverse (bool)
If True, the Iteration output will start at Count - 1 and go down towards 0.
Outputs
LoopStart (AsyncCall)
Fires after * is pulsed and before any iterations are done. Will be pulsed even if Count < 1.
LoopIteration (AsyncCall)
Fires for each iteration of the loop. This impulse is triggered Count amount of times and the next iteration will only be fired once the current iteration's context is finished.
LoopEnd (Continuation)
Fires after the final LoopIteration completes execution.
Iteration (int)
For each LoopIteration, this output is set to be the index of the iteration for said iteration's context. By default, this will start at 0 and increment until Count - 1 unless Reverse is True.