Difference between revisions of "Osiris/API/GetVarObject"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''GetVarObject'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(GUIDSTRING)'''''_UUID'''...") |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 7: | Line 7: | ||
* '''_UUID''': The GUID of the object stored in the variable. NULL if the variable does not exist or if it exists, but is neither a character, an item, or a trigger (but e.g. an Integer) | * '''_UUID''': The GUID of the object stored in the variable. NULL if the variable does not exist or if it exists, but is neither a character, an item, or a trigger (but e.g. an Integer) | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * The variable has to be | + | *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 query. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/SetVarObject|SetVarObject]] | * [[Osiris/API/SetVarObject|SetVarObject]] | ||
* [[Osiris/API/ClearVarObject|ClearVarObject]] | * [[Osiris/API/ClearVarObject|ClearVarObject]] | ||
| − | |||
| − | |||
| − | |||
* [[Osiris/API/GetVarInteger|GetVarInteger]] | * [[Osiris/API/GetVarInteger|GetVarInteger]] | ||
* [[Osiris/API/SetVarInteger|SetVarInteger]] | * [[Osiris/API/SetVarInteger|SetVarInteger]] | ||
Latest revision as of 18:48, 20 December 2017
Full Definition(s)
- query GetVarObject([in](GUIDSTRING)_Source, [in](String)_Varname, [out](GUIDSTRING)_UUID)
Description
Returns the value of the variable %<_Varname> of _Source, if it a character, item, or trigger.
Return Values
- Success/Failure: Fails if _Source does not exist.
- _UUID: The GUID of the object stored in the variable. NULL if the variable does not exist or if it exists, but is neither a character, an item, or a trigger (but e.g. an Integer)
Notes
- 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 query.
