VisionaireObject Command: getBool - Revision history

EK at 19:13, 11 August 2023

2023-08-11T19:13:17Z

EK at 19:09, 11 August 2023

2023-08-11T19:09:23Z

EK at 19:07, 11 August 2023

2023-08-11T19:07:22Z

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

2023-08-11T18:06:02Z

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

EK at 18:05, 11 August 2023

2023-08-11T18:05:15Z

David Stoffel: Text replacement - "{{toc}}" to ""

2014-11-03T23:52:53Z

Text replacement - "{{toc}}" to ""

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}}

@@ Line 17: / Line 17: @@
 |-
 | field
-| int
+| integer
 | 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.''

@@ Line 19: / Line 19: @@
 | 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.''
+''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.
 <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(194)

@@ Line 39: / Line 39: @@
 '''Example 1:''' Get the boolean value of a condition.
 <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(194)

@@ Line 1: / Line 1: @@
-{| class="toccolours mw-collapsible mw-collapsed ts"
+Returns the boolean value of a VisionaireObject field.
-Returns the boolean value of a linked condition. A boolean value is either <span style="color:lightgreen;">true</span> or <span class="red">false</span>.
+== Syntax ==
+<syntaxhighlight lang="lua">
+getBool(field)
 </syntaxhighlight>
-Example: using getBool to return the boolean value of a condition
+== Parameters ==
-none
+== Return values ==
-none
+== Examples ==
-<span class="bold underline">Return</span>
+-- Specify the field by its id
-'''t_bool''' <br/>
+-- The shorthand notation offers a more convenient way to achieve the same
-Returns <span style="color:lightgreen;">true</span> or <span class="red">false</span>.
+local door_state = Conditions["door_closed"].Value

← Older revision		Revision as of 23:52, 3 November 2014
Line 36:		Line 36:
	'''t_bool''' <br/>		'''t_bool''' <br/>
	Returns <span style="color:lightgreen;">true</span> or <span class="red">false</span>.		Returns <span style="color:lightgreen;">true</span> or <span class="red">false</span>.
−	~~{{toc}}~~

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