Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
(Changed parameter format)
 
(70 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma |= Game name
+
|game1= arma1
 +
|version1= 1.00
  
|1.00|= Game version
+
|game2= arma2
 +
|version2= 1.00
  
|arg= local |= Arguments in MP
+
|game3= arma2oa
 +
|version3= 1.50
  
|eff= local |= Effects in MP
+
|game4= tkoh
____________________________________________________________________________________________
+
|version4= 1.00
  
| Set variable to given value in the variable space of given element.
+
|game5= arma3
<br>
+
|version5= 0.50
To remove a variable, set it to [[nil]] (e.g. {{Inline code|[[player]] [[setVariable]] ["varname", [[nil]]<nowiki>]</nowiki>;}}).
 
<br>
 
<br>
 
All available data type combinations:
 
* [[Namespace]] setVariable [[Array]]
 
* [[Control]] setVariable [[Array]] (static map editor control only)
 
* [[Object]] setVariable [[Array]]
 
* [[Group]] setVariable [[Array]]
 
* [[Team_Member]] setVariable [[Array]]
 
* [[Task]] setVariable [[Array]]
 
* [[Location]] setVariable [[Array]]
 
  
{{Feature arma3|In Arma 3 it is possible to broadcast [[nil]] value}}|= Description
+
|arg= global
____________________________________________________________________________________________
 
  
| objectName '''setVariable''' [name, value, ''public''] |= Syntax
+
|eff= local
  
|p1= objectName: [[Object]] or [[Location]]. Arma 2 also supports: [[Namespace]], [[Group]], [[Control]], [[Task]] |= Parameter 1
+
|gr1= Multiplayer
|p2= [name, value]: [[Array]] |= Parameter 2
 
|p3= name: [[String]] |= Parameter 3
 
|p4= value: [[Any_Value]] |= Parameter 4
 
|p5= ''public'' (optional): [[Boolean]] - Only available for [[Object]] types. If public is true then the value is broadcast to all computers. |= Parameter 5
 
  
| [[Nothing]] |= Return value
+
|gr2= Variables
____________________________________________________________________________________________
 
  
|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]<nowiki>]</nowiki>;</code> |= Example 1
+
|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}}).
  
|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]]<nowiki>]</nowiki>;</code> |= Example 2
+
{{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:
 +
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 [[:Category:Scripting Commands|all available script commands]].
 +
}}
  
|x3= <code>[[missionNamespace]] [[setVariable]] ["myName", "KK"];
+
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.
[[hint]] myName; //KK</code> |= Example 3
 
  
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.
+
|s1= varspace [[setVariable]] [name, value, public]
<br>
 
Since Arma 2: '''If''' the '''public''' parameter for supported types is ''<tt>true</tt>'', the value will be '''synchronized''' also for a [[Join In Progress|JIP]] player. |= Multiplayer
 
  
| [[getVariable]], [[allVariables]], [[6thSense.eu:EG|MP editing guide]]|= See also
+
|p1= varspace: variable space in which variable can be set. Can be one of:
 +
* [[Namespace]]
 +
* [[Object]]
 +
* [[Group]]
 +
* [[Location]] (only [[createLocation|scripted]] ones)
 +
* [[Team Member]] ({{Since|arma2}})
 +
* [[Task]] ({{Since|arma2}}) - '''value''' will actually be set on the [[Task]]'s [[FSM]]. If none exist, the data will not be set.
 +
* [[Control]] ({{Since|arma3}})
 +
* [[Display]] ({{Since|arma3}})
  
}}
+
|p2= name: [[String]] - variable name ([[Identifier]])
  
<h3 style="display:none">Notes</h3>
+
|p3= value: [[Anything]] - variable value
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on 18 August, 2007 - 09:51
 
<dt class="note">[[User:Killswitch|Killswitch]]
 
<dd class="note">According to Suma, beginning with ArmA version 1.08, "setVariable now should work on any entity which can be targeted by AI, including soldier and game logic units. This includes most buildings, but not other static objects.
 
  
Using it with buildings one should be aware the building may be discarded because of streaming. In such case the variable space is lost. When used for buildings, the storage should therefore be considered non-reliable." Reference: [http://bugs.armed-assault.net/view.php?id=2444 Make setVariable work on other things than just vehicles]
+
|p4= public (Optional, default: [[false]]): {{Since|arma2||y}}
 +
* [[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]]
  
 +
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}}
 +
{{!}}}
  
<dd class="notedate">Posted on 3 November, 2009 - 19:40 (CEST)
+
|r1= [[Nothing]]
<dt class="note">[[User:WGL.Q|.kju]]
 
<dd class="note">Public variable parameter works also for groups in ArmA II. [http://dev-heaven.net/issues/show/5542 Ref: A2 CIT].
 
  
 +
|x1= <code>_myTruck [[setVariable]] ["TAG_myPublicVariable", 123, [[true]]];</code>
  
<dd class="notedate">Posted on January 18, 2010 - 17:27 (CEST)
+
|x2= <code>_myTruck [[setVariable]] ["TAG_myLocalVariable", ["321", _var], [[driver]] _myTruck];</code>
<dt class="note">'''[[User:Lou Montana|Lou Montana]]'''
 
<dd class="note">this command doesn't work with [[createSimpleTask|tasks]] in '''Arma 2 1.05'''
 
  
<dd class="notedate">Posted on February 8, 2010 - 18:42 (CEST)
+
|x3= <code>[[missionNamespace]] [[setVariable]] ["TAG_myName", "Brian"];
<dt class="note">'''[[User:LaKing|LaKing]]'''
+
[[hint]] TAG_myName; {{cc|hints "Brian"}}</code>
<dd class="note">In '''Arma 2 1.05''' the [[missionNamespace]] object allows only the two main Arguments by syntax. Publishing the Variable afterwards works fine.
 
  
<dd class="notedate">Posted on January 25, 2011 - 02:48 (CEST)
+
|x4= Get the current value of a variable or, if it is undefined, define it and then get the value:
<dt class="note">'''[[User:Lou Montana|Lou Montana]]'''
+
<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "VarName";
<dd class="note">this command '''does''' work with [[createSimpleTask|tasks]] in '''Arma 2 OA 1.57'''
+
[[if]] ([[isNil]] "_var") [[then]] {
 +
_var = 123;
 +
[[missionNamespace]] [[setVariable]] ["VarName", _var];
 +
};
 +
{{cc|_var now contains the current value of the [[missionNamespace]] variable varName}}</code>
  
<dd class="notedate">Posted on 19 July, 2011
+
|x5= Remove <tt>TAG_myPublicVariable</tt> from <tt>_myTruck</tt> (globally):
<dt class="note">[[User:kju|kju]]
+
<code>_myTruck [[setVariable]] ["TAG_myPublicVariable", [[nil]], [[true]]];</code>
<dd class="note">My finds with 1.59 are:
 
* not working for [[Task]] (example anyone?)
 
* public is JIP synced for [[Object]] and [[Group]]
 
* public parameter is not available for [[Namespace]], [[Location]] (, [[Task]])
 
  
<dd class="notedate">Posted on 8 May, 2012
+
|seealso= [[getVariable]] [[allVariables]] [[setFSMVariable]]
<dt class="note">[[User:Krause|Krause]]
+
}}
<dd class="note">IMPORTANT: This will not work on groups if you do it from the init line (you'll experience locality issues). Do something like this instead:
 
Put this on init line:
 
<code>b_GroupSetup = [ [[group]] this, "3/B", "Tank", "Platoon"] [[execVM]] "grouptest.sqf";</code>
 
grouptest.sqf:
 
<code>[[if]] ([[isServer]]) [[then]] {
 
[[private]] ["_GroupSelect", "_GroupDesig", "_GroupType", "_GroupSize"];
 
_GroupSelect = _this [[select]] 0;
 
_GroupDesig = _this [[select]] 1;
 
_GroupType = _this [[select]] 2;
 
_GroupSize = _this [[select]] 3;
 
_GroupSelect [[setVariable]] ["groupDetails", [_GroupDesig, _GroupType, _GroupSize, 0, [], ""], [[true]] ];
 
};</code>
 
  
<!-- Note Section END -->
+
<dl class="command_description">
</dl>
 
 
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
  
<!-- CONTINUE Notes -->
+
<dt></dt>
<dl class="command_description">
+
<dd class="notedate">Posted on December 9, 2015 - 20:18 (UTC)</dd>
<dd class="notedate">Posted on June 13, 2014 - 19:19 (UTC)</dd>
+
<dt class="note">[[User:Commy2|Commy2]]</dt>
<dt class="note">'''[[User:Astus Darkblossom|Astus Darkblossom]]'''</dt>
 
 
<dd class="note">
 
<dd class="note">
(A3) Disable randomization and set a color to randomized vehicles by using ‘this [[setVariable]] ["color",X]’ in the init of the vehicle where X is a number ranging from 0 to the number of skins (minus 1). If the number is out of range, the skin is still randomized.
+
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
 

Latest revision as of 10:28, 17 July 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
public (Optional, default: false): Since Arma 2 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], 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 December 9, 2015 - 20:18 (UTC)
Commy2
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.