Difference between revisions of "Osiris/API/GetVarFloat3"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''GetVarFloat3'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(REAL)'''''_X''', '''''[o...") |
m |
||
| Line 9: | Line 9: | ||
* '''_Z''': The third coordinate in '''_Varname'''. | * '''_Z''': The third coordinate in '''_Varname'''. | ||
===== 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 GetVarFloat3([in](GUIDSTRING)_Source, [in](String)_Varname, [out](REAL)_X, [out](REAL)_Y, [out](REAL)_Y)
Description
Returns the value of the variable %<_Varname> of _Source, if it is a Float3, i.e. a set of coordinates.
Return Values
- Success/Failure: Fails if _Source does not exist, or if the variable does not exist (or exists but has the wrong type).
- _X: The first coordinate in _Varname.
- _Y: The second coordinate in _Varname.
- _Z: The third coordinate in _Varname.
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.
