Osiris/API/GetVarFloat

Full Definition(s)

• query GetVarFloat([in](GUIDSTRING)_Source, [in](String)_Varname, [out](REAL)_VarValue)

Description

Returns the value of the variable %<_Varname> of _Source, if it is a floating-point number.

Return Values

• Success/Failure: Fails if _Source does not exist.
• _VarValue: The value of the queried floating-point number.

Notes

• The variable has to be a global variable. The _Varname does not include the prefix % that is used for global variables in behaviourscript. E.g. a variable that is called %Variable in behaviourscript would simply be Variable for the purposes of this query.
• There is no automatic conversion between Integers and Floats.

See Also

• GetVarObject
• SetVarObject
• ClearVarObject
• GetVarInteger
• SetVarInteger
• SetVarFloat
• GetVarString
• SetVarString
• GetVarFloat3
• SetVarFloat3
• GetVarFixedString
• SetVarFixedString