ForEachInCustomTableBlock

Inheritance 2 ancestors · 5 siblings

• IScriptBlock
  • ILoopScriptBlock
    • ForEachInCustomTableBlockcurrent
    • ForEachInSortedCustomTableBlock
    • GameEntityLoopBlock4
    • LoopBlock
    • RemoveEachFromCustomTableWhereBlock
    • WhileLoopBlock

Class Documentation

Edit documentation

A loop over the entries of a custom table. For each entry, the loop writes the key to DestKey and the value to DestValue and runs the body. The loop ends after the last entry, on a break, or at the first entry whose value is null.

The loop visits the string keys first, then the int keys in ascending order, then the other keys. SortedByKeys orders the string keys only: the int keys still come after all string keys.

Properties

DestKey

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

Documentation Edit documentation

The variable that receives the key of the entry before each run of the body.

DestValue

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

Documentation Edit documentation

The variable that receives the value of the entry before each run of the body.

Sequence

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

Removed in 14.5

Documentation Add documentation

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

SortedByKeys

Pointer<IBoolGet> = null

Documentation Edit documentation

If true, the loop visits the string keys in string order. If it is false or not set, the string keys come in an internal order.

Table

Embed<CustomTableGet> = { "Table": {}, "Var": "0x0" }

Documentation Edit documentation

The table to walk.

DestKey

DestValue

Sequence

SortedByKeys

Table