BoolTableGet

Inheritance 3 ancestors · 29 siblings

Class Documentation

A getter that reads a script variable as a bool. If the variable holds a Bool, the getter returns it. Otherwise, or if the variable does not exist, the getter returns Default if it is set and fails with a script error if it is not. The same rule applies when the getter is read as a plain value. See ScriptTableGet for Table and Var.

Properties

Default

Option<Bool> = null

Documentation Edit documentation

The bool the getter returns if the variable is missing or is not a Bool. Unset, the getter fails instead.