Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
(fix an example: public flag can't be object)
 
(5 intermediate revisions by 2 users not shown)
Line 24: Line 24:
 
|gr2= Variables
 
|gr2= Variables
  
|descr= Set variable to given value in the variable space of given element.
+
|descr= Set variable to given value in the variable space of given element. Can be used to broadcast variables over the network. To remove a variable, set it to [[nil]] (see {{HashLink|#Example 5}}).
* To remove a variable, set it to [[nil]] (e.g. {{ic|[[player]] [[setVariable]] ["varname", [[nil]]<nowiki>]</nowiki>;}}).
 
* When variable is set on [[Task]], it is not actually set on task itself, but on FSM attached to the task. So if there is no FSM [[setVariable]] will not work.
 
* When variable is set on [[Location]], it works only with locations created with [[createLocation]].
 
  
{{Feature|arma3|In Arma 3 it is possible to broadcast [[nil]] value!}}
+
{{Feature | Warning | [[missionNamespace]], [[uiNamespace]], [[parsingNamespace]] and [[profileNamespace]] variable names can be any string but reserved names such as script commands. For example: <tt>[[missionNamespace]] setVariable ["west", 123];</tt> will result in error:
 
 
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.<br>
 
Since Arma 2: '''If''' the '''public''' parameter for supported types is ''<tt>true</tt>'', the value will be '''synchronized''' also for a [[Multiplayer Scripting#Join In Progress|JIP]] player.
 
 
 
|pr= {{Feature | Warning | [[missionNamespace]], [[uiNamespace]], [[parsingNamespace]] and [[profileNamespace]] variable names could be any string, except for the reserved names, which are normally script command names. For example: <tt>[[missionNamespace]] setVariable ["west", 123];</tt> will result in error:  
 
 
  Error in expression <missionNamespace setVariable ["west", 123];>
 
  Error in expression <missionNamespace setVariable ["west", 123];>
    Error position: <setVariable ["west", 123];>
+
Error position: <setVariable ["west", 123];>
    Error Reserved variable in expression
+
Error Reserved variable in expression
as [[west]] is a script command. Other varspaces do not have such limitation. You can always check for all available script commands by running [[Arma_3_Utilities#Script_Commands | utility number 5]]}}
+
as [[west]] is a scripting command. Other varspaces do not have such limitation. See also [[:Category:Scripting Commands|all available script commands]].
 +
}}
  
|s1= varspace [[setVariable]] [name, value]
+
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.
  
|p1= varspace: [[Namespace]], [[Object]], [[Group]], [[Team Member]], [[Task]], [[Location]], [[Control]], [[Display]] - Variable space in which variable can be set
+
|s1= varspace [[setVariable]] [name, value, public]
{{Feature|arma3|Since Arma 3 also [[Control]] and [[Display]] are supported types.}}
 
|p2= name: [[String]] - Variable name
 
  
|p3= value: [[Anything]] - Variable value
+
|p1= varspace: variable space in which variable can be set. Can be one of:
 +
{{Columns|2|
 +
* [[Namespace]]
 +
* [[Object]]
 +
* [[Group]]
 +
* [[Location]] ([[createLocation|scripted]] ones only)
 +
* {{GVI|arma2|1.00|size=0.75}} [[Team Member]]
 +
* {{GVI|arma2|1.00|size=0.75}} [[Task]] - ''value'' will actually be set on the [[Task]]'s [[FSM]] '''if''' it exists.
 +
* {{GVI|arma3|0.50|size=0.75}} [[Control]]
 +
* {{GVI|arma3|0.50|size=0.75}} [[Display]]
 +
|shrink= y
 +
}}
  
|r1= [[Nothing]]
+
|p2= name: [[String]] - variable name ([[Identifier]])
  
|s2= varspace [[setVariable]] [name, value, public]
+
|p3= value: [[Anything]] - variable value
  
|p21= varspace: [[missionNamespace]], [[Object]] or [[Group]] - Variable space in which variable can be set
+
|p4= public - (Optional, default: [[false]]) can be one of:
 +
* [[Boolean]] - if set to [[true]], the variable is broadcast globally and is persistent ([[Multiplayer Scripting#Join In Progress|JIP]] compatible) {{Icon|globalEffect|32}}
 +
* [[Number]] - the variable is only set on the client with the given [[Multiplayer Scripting#Machine network ID|Machine network ID]]. If the number is negative, the variable is set on every client except for the one with the given ID.
 +
* [[Array]] of [[Number]]s - array of [[Multiplayer Scripting#Machine network ID|Machine network IDs]]
  
|p22= name: [[String]] - Variable name
+
This parameter is only available if the '''varspace''' parameter is a [[Namespace]], [[Object]] or [[Group]]. Furthermore, only the following [[:Category: Data Types|Data Types]] can be broadcast:
 +
{{{!}} class="wikitable" style="text-align: center"
 +
! Type
 +
{{!}} [[Number]]
 +
{{!}} [[Boolean]]
 +
{{!}} [[Object]]
 +
{{!}} [[Group]]
 +
{{!}} [[String]]
 +
{{!}} [[Text]]
 +
{{!}} [[Array]]
 +
{{!}} [[Code]]
 +
{{!}} [[Nothing]] ([[nil]])
 +
{{!}} [[HashMap]]
 +
{{!}}-
 +
! Since
 +
{{!}} {{GVI|ofp|1.34}}
 +
{{!}} {{GVI|ofp|1.34}}
 +
{{!}} {{GVI|ofp|1.34}}
 +
{{!}} {{GVI|ofp|1.34}}
 +
{{!}} {{GVI|arma1|1.00}}
 +
{{!}} {{GVI|arma1|1.00}}
 +
{{!}} {{GVI|arma1|1.09}}
 +
{{!}} {{GVI|arma1|1.09}}
 +
{{!}} {{GVI|arma3|1.26}}
 +
{{!}} {{GVI|arma3|2.02}}
 +
{{!}}}
 +
|p4since= arma2 1.00
  
|p23= value: [[Anything]] - Variable value (if public is [[true]], check [[publicVariable]] for what types are supported for broadcast)
+
|r1= [[Nothing]]
 
 
|p24= public: [[Boolean]], [[Number]] or [[Array]] of [[Number]]s
 
* [[Boolean]] - When [[true]], the variable broadcast is global and persistent {{Icon|globalEffect|32}}
 
 
 
* [[Number]] - The variable is set only on the client of given [[owner]] ([[clientOwner]]) id, or if id is negative, the variable is set on every client except the given one
 
 
 
* [[Array]] of [[Number]]s - Array of [[owner]] ([[clientOwner]]) ids
 
 
 
|r2= [[Nothing]]
 
  
|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]];</code>
+
|x1= <code>_myTruck [[setVariable]] ["TAG_myPublicVariable", 123, [[true]]];</code>
  
|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]]];</code>
+
|x2= <code>_myTruck [[setVariable]] ["TAG_myLocalVariable", ["321", _var], [[owner]] [[driver]] _myTruck];</code>
  
|x3= <code>[[missionNamespace]] [[setVariable]] ["myName", "KK"];
+
|x3= <code>[[missionNamespace]] [[setVariable]] ["TAG_myName", "Brian"];
[[hint]] myName; {{cc|KK}}</code>
+
[[hint]] TAG_myName; {{cc|hints "Brian"}}</code>
  
|x4= Get current value of a variable and if it is undefined, define it and get the defined value:<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "varName";
+
|x4= Get the current value of a variable or, if it is undefined, define it and then get the value:
[[if]] ([[isNil]] "_var") [[then]]
+
<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "VarName";
{
+
[[if]] ([[isNil]] "_var") [[then]] {
[[missionNamespace]] [[setVariable]] ["varName", 123];
 
 
_var = 123;
 
_var = 123;
 +
[[missionNamespace]] [[setVariable]] ["VarName", _var];
 
};
 
};
{{cc|_var here will contain current value of the variable varName}}</code>
+
{{cc|_var now contains the current value of the [[missionNamespace]] variable varName}}</code>
  
|seealso= [[getVariable]], [[allVariables]], [[setFSMVariable]], [[Multiplayer Scripting#Join In Progress|Multiplayer Scripting]]
+
|x5= Remove <tt>TAG_myPublicVariable</tt> from <tt>_myTruck</tt> (globally):
 +
<code>_myTruck [[setVariable]] ["TAG_myPublicVariable", [[nil]], [[true]]];</code>
 +
 
 +
|seealso= [[getVariable]] [[allVariables]] [[setFSMVariable]]
 
}}
 
}}
  
<dl class="command_description">
+
{{Note
 
+
|user= Commy2
<dt></dt>
+
|timestamp= 20151209201800
<dd class="notedate">Posted on December 9, 2015 - 20:18 (UTC)</dd>
+
|text= This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.
<dt class="note">[[User:Commy2|Commy2]]</dt>
+
}}
<dd class="note">
 
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.
 
</dd>
 
 
 
</dl>
 

Latest revision as of 19:43, 28 August 2021

Hover & click on the images for description

Description

Description:
Set variable to given value in the variable space of given element. Can be used to broadcast variables over the network. To remove a variable, set it to nil (see Example 5).
missionNamespace, uiNamespace, parsingNamespace and profileNamespace variable names can be any string but reserved names such as script commands. For example: missionNamespace setVariable ["west", 123]; will result in error:
Error in expression <missionNamespace setVariable ["west", 123];>
	Error position: <setVariable ["west", 123];>
	Error Reserved variable in expression
as west is a scripting command. Other varspaces do not have such limitation. See also all available script commands.
Multiplayer:
The variable space of the object is local to each client and by default changes are not broadcast.
Groups:
MultiplayerVariables

Syntax

Syntax:
varspace setVariable [name, value, public]
Parameters:
varspace: variable space in which variable can be set. Can be one of:
name: String - variable name (Identifier)
value: Anything - variable value
since 25.2px1.00
public - (Optional, default: false) can be one of: This parameter is only available if the varspace parameter is a Namespace, Object or Group. Furthermore, only the following Data Types can be broadcast:
Type Number Boolean Object Group String Text Array Code Nothing (nil) HashMap
Since Logo A0.png1.34 Logo A0.png1.34 Logo A0.png1.34 Logo A0.png1.34 Logo A1 black.png1.00 Logo A1 black.png1.00 Logo A1 black.png1.09 Logo A1 black.png1.09 Arma 3 logo black.png1.26 Arma 3 logo black.png2.02
Return Value:
Nothing

Examples

Example 1:
_myTruck setVariable ["TAG_myPublicVariable", 123, true];
Example 2:
_myTruck setVariable ["TAG_myLocalVariable", ["321", _var], owner driver _myTruck];
Example 3:
missionNamespace setVariable ["TAG_myName", "Brian"]; hint TAG_myName; // hints "Brian"
Example 4:
Get the current value of a variable or, if it is undefined, define it and then get the value: private _var = missionNamespace getVariable "VarName"; if (isNil "_var") then { _var = 123; missionNamespace setVariable ["VarName", _var]; }; // _var now contains the current value of the missionNamespace variable varName
Example 5:
Remove TAG_myPublicVariable from _myTruck (globally): _myTruck setVariable ["TAG_myPublicVariable", nil, true];

Additional Information

See also:
getVariable allVariables setFSMVariable

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Posted on Dec 09, 2015 - 20:18 (CEST)
Commy2
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.