View source for ProtoFlux:ASync Range Loop Int

{{#Invoke:ProtoFlux|GenerateUI
|Name=Async Range Loop
|Category=Async
|Inputs=
[
{"Name": "*", "Type": "AsyncCall"},
{"Name": "Start", "Type": "int"},
{"Name": "End", "Type": "int"},
{"Name": "StepSize", "Type": "int"}
]
|Outputs=
[
{"Name": "LoopStart", "Type":"AsyncCall"},
{"Name": "LoopIteration", "Type":"AsyncCall"},
{"Name": "LoopEnd", "Type": "Continuation"},
{"Name": "Current", "Type": "int"}
]
|}}

{{Stub}}<i> Missing clarification </i>

Range Loop Int is a ProtoFlux node that allows for firing a bunch of executions like an [[ProtoFlux:ASync For|ASync For Loop]] except that instead of having to go one at a time from 0->count, you can specify a Start ([[Type:Int|int]]) number, End ([[Type:Int|int]]) number, and a StepSize ([[Type:Int|int]]) which all determine the range of numbers that will come out of Current ([[Type:Int|int]]) during execution and the distance between each Current ([[Type:Int|int]]) outputted.

This node will do a bunch of async tasks in order in an Async context, waiting for each task to be done before moving to the next one. This is useful if you want to do a bunch of [[ProtoFlux:GET String|GET String]] requests but you need to wait for the previous one to be done before doing the next, for a specified number of times. This does not behave the same as using a [[ProtoFlux:Start ASync Task|Start ASync Task]] on every [[ProtoFlux:Range Loop Int|Range Loop Int]] iteration or even before the [[ProtoFlux:Range Loop Int|Range Loop Int]] using a [[ProtoFlux:Start ASync Task|Start ASync Task]].

== Inputs ==

=== * ([[Impulses#ASync|IAsyncOperation]]) ===

Start Execution of the ASync Range Loop.

=== Start ([[Type:Int|int]]) ===

The number to start at when executing.

=== End ([[Type:Int|int]]) ===

The number to end at when executing.

TODO: Is this inclusive or exclusive?

=== StepSize ([[Type:Int|int]]) ===

How much to add to Start ([[Type:Int|int]]) per execution for the Current ([[Type:Int|int]]) output number.

== Outputs ==

=== LoopStart ([[Impulses#ASync|AsyncCall]]) ===

Fires when the loop starts, regardless of executions of the ASync Range Loop.

=== LoopIteration ([[Impulses#ASync|AsyncCall]]) ===

Fires every time Current ([[Type:Int|int]]) increases by StepSize ([[Type:Int|int]]) and (has just or hasn't/hasn't)? hit the End ([[Type:Int|int]]) limit. Waits till the previous LoopIteration ([[Impulses#ASync|AsyncCall]]) is done or after LoopStart ([[Impulses#ASync|AsyncCall]]) is done before firing this one.

TODO: Is this inclusive or exclusive?

=== LoopEnd ([[Impulses|Continuation]]) ===

Fires once the loop has finished.

=== Current ([[Type:Int|int]]) ===

The current number between Start ([[Type:Int|int]]) and End ([[Type:Int|int]]). has a value during every LoopIteration ([[Impulses#ASync|AsyncCall]]).

== Examples ==

<gallery widths=480px heights=480px>
File:Protoflux_example_ASync_Range_Loop_Int.webp|ASync Range Loop Int being used to iterate over every other character in a string using [[ProtoFlux:Get Character|Get Character]] and then calling a read cloud variable using the character.
</gallery>

[[Category:ProtoFlux:Flow:Async]]