Osiris/API/GetVarInteger - Revision history

LarIlya at 16:48, 20 December 2017

2017-12-20T16:48:50Z

← Older revision		Revision as of 16:48, 20 December 2017
Line 7:		Line 7:
	* '''_VarValue''': The value of the queried integer variable.		* '''_VarValue''': The value of the queried integer variable.
	===== 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.
	* Can also be used to query variables of the SURFACE type. Because Osiris works with string names, however, a conversion with [[Osiris/API/GetSurfaceNameByTypeIndex\|GetSurfaceNameByTypeIndex]] is required.		* Can also be used to query variables of the SURFACE type. Because Osiris works with string names, however, a conversion with [[Osiris/API/GetSurfaceNameByTypeIndex\|GetSurfaceNameByTypeIndex]] is required.
	* Other types stored in Enums can also be queried with this, but there are currently no conversion functions.		* Other types stored in Enums can also be queried with this, but there are currently no conversion functions.

LarIlya at 16:34, 20 December 2017

2017-12-20T16:34:48Z

← Older revision		Revision as of 16:34, 20 December 2017
Line 8:		Line 8:
	===== 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 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.
	* Can also be used to query variables of the SURFACE type. Because Osiris works with string names, however, a conversion with [[Osiris/API/GetSurfaceNameByTypeIndex]] is required.		* Can also be used to query variables of the SURFACE type. Because Osiris works with string names, however, a conversion with [[Osiris/API/GetSurfaceNameByTypeIndex\|GetSurfaceNameByTypeIndex]] is required.
	* Other types stored in Enums can also be queried with this, but there are currently no conversion functions.		* Other types stored in Enums can also be queried with this, but there are currently no conversion functions.
	===== See Also =====		===== See Also =====

LarIlya at 16:33, 20 December 2017

2017-12-20T16:33:49Z

← Older revision		Revision as of 16:33, 20 December 2017
Line 8:		Line 8:
	===== 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 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.
			* Can also be used to query variables of the SURFACE type. Because Osiris works with string names, however, a conversion with [[Osiris/API/GetSurfaceNameByTypeIndex]] is required.
			* Other types stored in Enums can also be queried with this, but there are currently no conversion functions.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/GetVarObject\|GetVarObject]]		* [[Osiris/API/GetVarObject\|GetVarObject]]

LarIlya at 16:26, 20 December 2017

2017-12-20T16:26:53Z

← Older revision		Revision as of 16:26, 20 December 2017
Line 4:		Line 4:
	Returns the value of the variable %<'''_Varname'''> of '''_Source''', if it is an integer.		Returns the value of the variable %<'''_Varname'''> of '''_Source''', if it is an integer.
	===== Return Values =====		===== Return Values =====
	* '''Success/Failure''': Fails if '''_Source''' does not exist.		* '''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 integer variable.		* '''_VarValue''': The value of the queried integer variable.
	===== 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 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.
	* There is no automatic conversion between Integers and Floats.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/GetVarObject\|GetVarObject]]		* [[Osiris/API/GetVarObject\|GetVarObject]]

LarIlya at 16:21, 20 December 2017

2017-12-20T16:21:57Z

← Older revision		Revision as of 16:21, 20 December 2017
Line 2:		Line 2:
	* query '''GetVarInteger'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(INTEGER)'''''_VarValue''')		* query '''GetVarInteger'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(INTEGER)'''''_VarValue''')
	===== Description =====		===== Description =====
	Returns the value of the variable %<'''_Varname'''> of '''_Source''', if it an integer.		Returns the value of the variable %<'''_Varname'''> of '''_Source''', if it is an integer.
	===== Return Values =====		===== Return Values =====
	* '''Success/Failure''': Fails if '''_Source''' does not exist.		* '''Success/Failure''': Fails if '''_Source''' does not exist.
Line 8:		Line 8:
	===== 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 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.
			* There is no automatic conversion between Integers and Floats.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/GetVarObject\|GetVarObject]]		* [[Osiris/API/GetVarObject\|GetVarObject]]

LarIlya at 16:20, 20 December 2017

2017-12-20T16:20:41Z

← Older revision		Revision as of 16:20, 20 December 2017
Line 12:		Line 12:
	* [[Osiris/API/SetVarObject\|SetVarObject]]		* [[Osiris/API/SetVarObject\|SetVarObject]]
	* [[Osiris/API/ClearVarObject\|ClearVarObject]]		* [[Osiris/API/ClearVarObject\|ClearVarObject]]
	* [[Osiris/API/GetVarInteger\|GetVarInteger]]
	* [[Osiris/API/SetVarInteger\|SetVarInteger]]		* [[Osiris/API/SetVarInteger\|SetVarInteger]]
	* [[Osiris/API/GetVarFloat\|GetVarFloat]]		* [[Osiris/API/GetVarFloat\|GetVarFloat]]

LarIlya: Created page with "===== Full Definition(s) ===== * query '''GetVarInteger'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(INTEGER)'''''_VarValue'..."

2017-12-20T16:20:32Z

Created page with "===== Full Definition(s) ===== * query '''GetVarInteger'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(INTEGER)'''''_VarValue'..."

New page

===== Full Definition(s) =====
* query '''GetVarInteger'''('''''[in]'''(GUIDSTRING)'''''_Source''', '''''[in]'''(String)'''''_Varname''', '''''[out]'''(INTEGER)'''''_VarValue''')
===== Description =====
Returns the value of the variable %<'''_Varname'''> of '''_Source''', if it an integer.
===== Return Values =====
* '''Success/Failure''': Fails if '''_Source''' does not exist.
* '''_VarValue''': The value of the queried integer variable.
===== 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.
===== See Also =====
* [[Osiris/API/GetVarObject|GetVarObject]]
* [[Osiris/API/SetVarObject|SetVarObject]]
* [[Osiris/API/ClearVarObject|ClearVarObject]]
* [[Osiris/API/GetVarInteger|GetVarInteger]]
* [[Osiris/API/SetVarInteger|SetVarInteger]]
* [[Osiris/API/GetVarFloat|GetVarFloat]]
* [[Osiris/API/SetVarFloat|SetVarFloat]]
* [[Osiris/API/GetVarString|GetVarString]]
* [[Osiris/API/SetVarString|SetVarString]]
* [[Osiris/API/GetVarFloat3|GetVarFloat3]]
* [[Osiris/API/SetVarFloat3|SetVarFloat3]]
* [[Osiris/API/GetVarFixedString|GetVarFixedString]]
* [[Osiris/API/SetVarFixedString|SetVarFixedString]]

[[Category:Osiris Queries|GetVarInteger]]