VisionaireObject Command: getBool - Revision history

EK at 19:13, 11 August 2023

2023-08-11T19:13:17Z

← Older revision		Revision as of 20:13, 11 August 2023
Line 17:		Line 17:
	\|-		\|-
	\| field		\| field
	\| ~~int~~		\| integer
	\| The field which specifies a boolean value. The field type must be "t_bool".		\| The field which specifies a boolean value. The field type must be "t_bool".
	''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''		''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''

EK at 19:09, 11 August 2023

2023-08-11T19:09:23Z

← Older revision		Revision as of 20:09, 11 August 2023
Line 19:		Line 19:
	\| int		\| int
	\| The field which specifies a boolean value. The field type must be "t_bool".		\| 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.''		''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''
	\|}		\|}

Line 39:		Line 39:
	'''Example 1:''' Get the boolean value of a condition.		'''Example 1:''' Get the boolean value of a condition.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Specify the field by the field ~~constant or by its~~ id		-- Specify the field constant name or the field id
	local door_state = getObject("Conditions[door_closed]"):getBool(VConditionValue)		local door_state = getObject("Conditions[door_closed]"):getBool(VConditionValue)
	local door_state = getObject("Conditions[door_closed]"):getBool(194)		local door_state = getObject("Conditions[door_closed]"):getBool(194)

EK at 19:07, 11 August 2023

2023-08-11T19:07:22Z

← Older revision		Revision as of 20:07, 11 August 2023
Line 39:		Line 39:
	'''Example 1:''' Get the boolean value of a condition.		'''Example 1:''' Get the boolean value of a condition.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Specify the field by the field constant		-- Specify the field by the field constant or by its id
	local door_state = getObject("Conditions[door_closed]"):getBool(VConditionValue)		local door_state = getObject("Conditions[door_closed]"):getBool(VConditionValue)

	~~-- Specify the field by its id~~
	local door_state = getObject("Conditions[door_closed]"):getBool(194)		local door_state = getObject("Conditions[door_closed]"):getBool(194)

EK: EK moved page GetBool (CMS) to VisionaireObject Command: getBool

2023-08-11T18:06:02Z

EK moved page GetBool (CMS) to VisionaireObject Command: getBool

← Older revision		Revision as of 19:06, 11 August 2023
(No difference)

EK at 18:05, 11 August 2023

2023-08-11T18:05:15Z

New page

Returns the boolean value of a VisionaireObject field.

== Syntax ==
<syntaxhighlight lang="lua">
getBool(field)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | 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 ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| The boolean value of the field.
|}

== Examples ==

'''Example 1:''' Get the boolean value of a condition.
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>
{{toc}}

AFRLme: Created page with "{| class="toccolours mw-collapsible mw-collapsed ts" |- ! Function History |- | Available since v3.0 |} Returns the boolean value of a linked condition. A boolean value is e..."

2014-09-28T16:32:09Z

Created page with "{| class="toccolours mw-collapsible mw-collapsed ts" |- ! Function History |- | Available since v3.0 |} Returns the boolean value of a linked condition. A boolean value is e..."

New page

{| class="toccolours mw-collapsible mw-collapsed ts"
|-
! Function History
|-
| Available since v3.0
|}

Returns the boolean value of a linked condition. A boolean value is either true or false.

Syntax:
<syntaxhighlight>
getBool(t_bool)
</syntaxhighlight>

Example: using getBool to return the boolean value of a condition
<syntaxhighlight>
getObject("Conditions[door_open]"):getBool(VConditionValue) -- return boolean value of condition "door_open"
</syntaxhighlight>

Arguments

none

Flags

none

Return

'''t_bool''' 
Returns true or false.
{{toc}}