LoopBlock

Inheritance 2 ancestors · 5 siblings

IScriptBlock
- ILoopScriptBlock

Class Documentation

A counting loop (see ILoopScriptBlock). The loop counts an index from Start to End in steps of step, and both ends are included.

Each iteration writes the index to Dest and then tests it. If step is positive, the test is index <= End; otherwise it is index >= End. If the test passes, the loop runs the body and adds step to the index. If it fails, the loop ends. After the loop, Dest holds the first index that failed the test.

Properties

Dest

Embed<IntTableSet> = { "Table": {}, "Var": "" }

Documentation Edit documentation

The int variable that receives the index before each test.

End

Pointer<IIntGet> = null

Documentation Edit documentation

The last index. It must be set: the client does not check for a missing operand.

InclusiveIteration

Bool = false

Removed in 14.24

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

Sequence

Embed<ScriptSequence> = { "blocks": [] }

Removed in 14.1

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

Start

Pointer<IIntGet> = null

Documentation Edit documentation

The first index. It must be set: the client does not check for a missing operand.

step

Pointer<IIntGet> = null

Documentation Edit documentation

The amount added to the index after each iteration. If step is not set, the step is 1.