ForEachInSortedCustomTableBlock

Inheritance 2 ancestors · 5 siblings

• IScriptBlock
  • ILoopScriptBlock
    • ForEachInCustomTableBlock
    • ForEachInSortedCustomTableBlockcurrent
    • GameEntityLoopBlock4
    • LoopBlock
    • RemoveEachFromCustomTableWhereBlock
    • WhileLoopBlock

Class Documentation

Edit documentation

A loop over the entries of a custom table, ordered by value. 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 sort applies to each kind of key on its own, not to the whole table. The loop visits the string-keyed entries first, sorted by value, then the int-keyed entries, sorted by value, then the entries with other keys, sorted by value.

Notes

• No shipped object uses it.

Properties

Ascending

Bool = true

Documentation Edit documentation

If true, each group of entries is sorted from the smallest value to the largest. If false, from the largest to the smallest.

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.

Table

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

Documentation Edit documentation

The table to walk.

Ascending

DestKey

DestValue

Table