Set_BoolVar

Parameters

Required:

Parameter1: A string representing the name of the variable.

Parameter2: A boolean representing the variable value.

Optional:

No optional parameters

Functionality

Declares a variable with the given value. If the variable already exists, then it updates the value of the variable to the given value. When updating the value of a variable, the type must be the same as the original value, or else this command will skip updating the value.

Boolean values can be either true or false.

Examples

Set_BoolVar ["MyBool", true]

Sets a boolean variable named MyBool to the value true. Given the variable does not exist, creates it.

Version Info

This command has been supported as of Oyster 4.1.0.