Osiris/API/ClearVarObject

Full Definition(s)

• call ClearVarObject((GUIDSTRING)_Source, (STRING)_VarName)

Description

Clears the value of the variable %<_Varname>, if the variable exists and is of the right type (i.e. TRIGGER, CHARACTER or ITEM).

Notes

• This is not equivalent to setting _VarName to NULL with SetVarObject. If a variable is set to NULL rather than cleared, IsEqual(%Variable, null) will evaluate to false for it.
• The variable has to be global. 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 call.

See Also

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