VisionaireObject Command: getFloat - Revision history

EK at 19:13, 11 August 2023

2023-08-11T19:13:04Z

EK at 19:09, 11 August 2023

2023-08-11T19:09:54Z

EK: Created page with "Returns the decimal value of a VisionaireObject field. == Syntax == getFloat(field) == Parameters == {| class="ts" |- ! st..."

2023-08-11T19:06:42Z

Created page with "Returns the decimal value of a VisionaireObject field. == Syntax == <syntaxhighlight lang="lua"> getFloat(field) </syntaxhighlight> == Parameters == {| class="ts" |- ! st..."

New page

Returns the decimal value of a VisionaireObject field.

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

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| field
| int
| The field which specifies a decimal value. The field type must be "t_float".
''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
|-
| decimal
| The decimal value of the field.
|}

== Examples ==

'''Example 1:''' Get the current size of a character.
<syntaxhighlight lang="lua">
-- Specify the field by the field constant or by its id
local char_size = getObject("Characters[hero]"):getFloat(VCharacterSize)
local char_size = getObject("Characters[hero]"):getFloat(749)

-- The shorthand notation offers a more convenient way to achieve the same
local char_size = Characters["hero"].Size
</syntaxhighlight>
{{toc}}

@@ Line 17: / Line 17: @@
 |-
 | field
-| int
+| integer
 | The field which specifies a decimal value. The field type must be "t_float".
 ''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 decimal value. The field type must be "t_float".
-''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 current size of a character.
 <syntaxhighlight lang="lua">
--- Specify the field by the field constant or by its id
+-- Specify the field constant name or the field id
 local char_size = getObject("Characters[hero]"):getFloat(VCharacterSize)
 local char_size = getObject("Characters[hero]"):getFloat(749)