Difference between revisions of "Osiris/API/GetVarString"
From Divinity Engine Wiki
m |
|||
| Line 7: | Line 7: | ||
* '''_VarValue''': The value of the queried String. | * '''_VarValue''': The value of the queried String. | ||
===== 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/GetVarObject|GetVarObject]] | * [[Osiris/API/GetVarObject|GetVarObject]] | ||
Latest revision as of 17:49, 20 December 2017
Full Definition(s)
- query GetVarString([in](GUIDSTRING)_Source, [in](String)_Varname, [out](STRING)_VarValue)
Description
Returns the value of the variable %<_Varname> of _Source, if it is a String.
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 String.
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.
