Difference between revisions of "Osiris/API/ClearVarObject"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * call '''SetVarObject'''(''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_VarName''') ===== Description ===== Clears the value of the variable %<...") |
m |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * call ''' | + | * call '''ClearVarObject'''(''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_VarName''') |
===== Description ===== | ===== Description ===== | ||
Clears the value of the variable %<'''_Varname'''>, if the variable exists and is of the right type (i.e. TRIGGER, CHARACTER or ITEM). | Clears the value of the variable %<'''_Varname'''>, if the variable exists and is of the right type (i.e. TRIGGER, CHARACTER or ITEM). | ||
| Line 21: | Line 21: | ||
| − | [[Category:Osiris Calls| | + | [[Category:Osiris Calls|ClearVarObject]] |
Latest revision as of 22:50, 1 July 2018
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.
