Difference between revisions of "Osiris/API/GetVarFixedString"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * query '''GetVarFixedString'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(STRING)'''''_VarVal...")
 
m
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
 
* '''_VarValue''': The value of the queried Fixedstring.
 
* '''_VarValue''': The value of the queried Fixedstring.
 
===== Notes =====
 
===== Notes =====
* The variable has to be a global variable. 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.
+
*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]]
Line 22: Line 22:
 
* [[Osiris/API/SetVarFixedString|SetVarFixedString]]
 
* [[Osiris/API/SetVarFixedString|SetVarFixedString]]
  
[[Category:Osiris Queries|GetVarString]]
+
[[Category:Osiris Queries|GetVarFixedString]]

Latest revision as of 17:49, 20 December 2017

Full Definition(s)
  • query GetVarFixedString([in](GUIDSTRING)_Source, [in](String)_Varname, [out](STRING)_VarValue)
Description

Returns the value of the variable %<_Varname> of _Source, if it is a Fixedstring.

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 Fixedstring.
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