GetRandomFromCustomTableBlock

Inheritance 1 ancestor · 45 siblings

IScriptBlock

Class Documentation

Edit documentation

A block that picks a random entry of a custom table. Every entry has the same chance. The block writes the key of the entry to KeyDest and its value to Dest. If ShouldRemove is true, the block then removes the entry from the table. If the table is empty, the block writes nothing.

Properties

Dest

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

Documentation Edit documentation

The variable that receives the value of the picked entry.

KeyDest

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

Documentation Edit documentation

The variable that receives the key of the picked entry.

ShouldRemove

Bool = false

Documentation Edit documentation

If true, the block removes the picked entry from Table.

Table

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

Documentation Edit documentation

The table to pick from.