ProtoFlux:Range Loop Int: Difference between revisions

From Resonite Wiki
Almost done, just needs clarification on inclusive or exclusive.
cleanup
Line 18: Line 18:
|}}
|}}


{{Stub}}<i> Missing clarification </i>
The '''Range Loop Int''' node is used to perform looping operations by allowing one to define a range of values and step size for iterations to follow. It is a more flexible version of the [[For]] node.
 
Range Loop Int is a ProtoFlux node that allows for firing a bunch of executions like a [[ProtoFlux:For|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.


== Inputs ==
== Inputs ==
Line 26: Line 24:
=== * ([[Type:Int|int]]) ===
=== * ([[Type:Int|int]]) ===


Start Execution of the Range Loop.
Begin the range loop.


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


The number to start at when executing.
The number for <code>Current</code> to start at during execution.


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


The number to end at when executing.
The number for <code>Current</code> to iterate towards and compare to during execution. This input is inclusive.
 
TODO: Is this inclusive or exclusive?


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


How much to add to Start ([[Type:Int|int]]) per execution for the Current ([[Type:Int|int]]) output number.
The value that is added or subtracted to <code>Current</code> per iteration for the current <code>LoopIteration</code>. The loop will either add or subtract this value depending on whether <code>Start</code> is less than or greater than <code>End</code>. There will be no iterations if this value is less than <code>1</code>.


== Outputs ==
== Outputs ==
Line 46: Line 42:
=== LoopStart ([[Impulses|Call]]) ===
=== LoopStart ([[Impulses|Call]]) ===


Fires when the loop starts, regardless of executions of the Range Loop.
Fires after <code>*</code> is pulsed and before any iterations are done. Will be pulsed even if <code>StepSize < 1</code>.


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


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.
Fires for each iteration of the loop. This impulse is triggered until <code>Current</code> exceeds <code>End</code> in the direction of the loop, at which point the iterations will stop.
 
TODO: Is this inclusive or exclusive?


=== LoopEnd ([[Impulses|Continuation]]) ===
=== LoopEnd ([[Impulses|Continuation]]) ===
Line 60: Line 54:
=== Current ([[Type:Int|int]]) ===
=== Current ([[Type:Int|int]]) ===


The current number between Start ([[Type:Int|int]]) and End ([[Type:Int|int]]). has a value during every LoopIteration ([[Impulses|Call]]).
This value will start at <code>Start</code> for the first iteration, then at each iteration, this value will either increase or decrease by <code>StepSize</code> depending on whether <code>End</code> is greater than or less than <code>Start</code>. This value lasts for said iteration's entire [[context]].


== Examples ==
== Examples ==
<gallery widths=480px heights=480px>
File:Protoflux_example_Range_Loop_Int.webp|Range Loop Int being used to iterate over every other character in a string using [[ProtoFlux:Get Character|Get Character]].
</gallery>


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

Revision as of 22:57, 12 December 2024

Range Loop
*
LoopStart
Start
LoopIteration
End
LoopEnd
StepSize
Current
Flow

The Range Loop Int node is used to perform looping operations by allowing one to define a range of values and step size for iterations to follow. It is a more flexible version of the For node.

Inputs

* (int)

Begin the range loop.

Start (int)

The number for Current to start at during execution.

End (int)

The number for Current to iterate towards and compare to during execution. This input is inclusive.

StepSize (int)

The value that is added or subtracted to Current per iteration for the current LoopIteration. The loop will either add or subtract this value depending on whether Start is less than or greater than End. There will be no iterations if this value is less than 1.

Outputs

LoopStart (Call)

Fires after * is pulsed and before any iterations are done. Will be pulsed even if StepSize < 1.

LoopIteration (Call)

Fires for each iteration of the loop. This impulse is triggered until Current exceeds End in the direction of the loop, at which point the iterations will stop.

LoopEnd (Continuation)

Fires once the loop has finished.

Current (int)

This value will start at Start for the first iteration, then at each iteration, this value will either increase or decrease by StepSize depending on whether End is greater than or less than Start. This value lasts for said iteration's entire context.

Examples