Osiris/API/GetVarInteger

Full Definition(s)

• query GetVarInteger([in](GUIDSTRING)_Source, [in](String)_Varname, [out](INTEGER)_VarValue)

Description

Returns the value of the variable %<_Varname> of _Source, if it is an integer.

Return Values

• Success/Failure: Fails if _Source does not exist, or if the variable does not exist (or exists but has the wrong type).
• _VarValue: The value of the queried integer variable.

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.
• Can also be used to query variables of the SURFACE type. Because Osiris works with string names, however, a conversion with Osiris/API/GetSurfaceNameByTypeIndex is required.
• Other types stored in Enums can also be queried with this, but there are currently no conversion functions.

See Also

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