VisionaireObject Command: getBool
From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 19:06, 11 August 2023 by EK (talk | contribs) (EK moved page GetBool (CMS) to VisionaireObject Command: getBool)
Returns the boolean value of a VisionaireObject field.
Syntax
getBool(field)
Parameters
| Parameter | Type | Description |
|---|---|---|
| field | int | The field which specifies a boolean value. The field type must be "t_bool".
Specify the field by the field constant (V + object table name in singular + field name) or by its id, see the example. |
Return values
| Type | Description |
|---|---|
| boolean | The boolean value of the field. |
Examples
Example 1: Get the boolean value of a condition.
-- Specify the field by the field constant
local door_state = getObject("Conditions[door_closed]"):getBool(VConditionValue)
-- Specify the field by its id
local door_state = getObject("Conditions[door_closed]"):getBool(194)
-- The shorthand notation offers a more convenient way to achieve the same
local door_state = Conditions["door_closed"].Value
