Osiris/API/GetVarFloat3

From Divinity Engine Wiki
Jump to: navigation, search
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.
See Also