RemoveEachFromCustomTableWhereBlock

Inheritance 2 ancestors · 5 siblings

• IScriptBlock
  • ILoopScriptBlock
    • ForEachInCustomTableBlock
    • ForEachInSortedCustomTableBlock
    • GameEntityLoopBlock4
    • LoopBlock
    • RemoveEachFromCustomTableWhereBlockcurrent
    • WhileLoopBlock

Class Documentation

Edit documentation

A loop that removes the entries of a custom table that the body selects. For each entry, the loop writes the key to IterKey and the value to IterValue and runs the body. After the body, the loop reads the bool variable ShouldRemove. If it holds true, the loop removes the entry. A value of another kind does not remove the entry.

The loop does not reset ShouldRemove between entries. A true that the body writes for one entry also removes the next entries, unless the body writes the variable for every entry.

Notes

• If the table of ShouldRemove cannot be found, the loop records a script error.
• No shipped object uses it.

Properties

IterKey

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

Documentation Edit documentation

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

IterValue

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

Documentation Edit documentation

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

ShouldRemove

Embed<BoolTableSet> = { "Table": {}, "Var": "ShouldRemove" }

Documentation Edit documentation

The bool variable that the body sets to true to remove the current entry.

Table

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

Documentation Edit documentation

The table to walk.

IterKey

IterValue

ShouldRemove

Table