Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
(Changed parameter format)
 
(121 intermediate revisions by 25 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 object or location. In MP, the variable space of the object is local to each client. Changes are not broadcast.
+
|game5= arma3
 +
|version5= 0.50
  
The object must be a vehicle, otherwise the function does nothing.  |= Description
+
|arg= global
____________________________________________________________________________________________
 
  
| [[Object]] '''setVariable''' ["name", [[Any_Value]]] |= Syntax
+
|eff= local
  
|p1= [[Object]] |= Parameter 1
+
|gr1= Multiplayer
  
|p2= name: [[String]]
+
|gr2= Variables
|p3= [[Any_Value]]
 
  
| [[Nothing]] |= Return value
+
|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}}).
____________________________________________________________________________________________
 
|x1= <code>_myTruck setVariable ["myVariable",123];</code> |= Example 1
 
  
| [[getVariable]] |= See also
+
{{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]].
 +
}}
 +
 
 +
|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]
 +
 
 +
|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]])
 +
 
 +
|p3= value: [[Anything]] - variable value
 +
 
 +
|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}}
 +
{{!}}}
 +
 
 +
|r1= [[Nothing]]
 +
 
 +
|x1= <code>_myTruck [[setVariable]] ["TAG_myPublicVariable", 123, [[true]]];</code>
 +
 
 +
|x2= <code>_myTruck [[setVariable]] ["TAG_myLocalVariable", ["321", _var], [[driver]] _myTruck];</code>
 +
 
 +
|x3= <code>[[missionNamespace]] [[setVariable]] ["TAG_myName", "Brian"];
 +
[[hint]] TAG_myName; {{cc|hints "Brian"}}</code>
 +
 
 +
|x4= Get the current value of a variable or, if it is undefined, define it and then get the value:
 +
<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "VarName";
 +
[[if]] ([[isNil]] "_var") [[then]] {
 +
_var = 123;
 +
[[missionNamespace]] [[setVariable]] ["VarName", _var];
 +
};
 +
{{cc|_var now contains the current value of the [[missionNamespace]] variable varName}}</code>
 +
 
 +
|x5= Remove <tt>TAG_myPublicVariable</tt> from <tt>_myTruck</tt> (globally):
 +
<code>_myTruck [[setVariable]] ["TAG_myPublicVariable", [[nil]], [[true]]];</code>
  
 +
|seealso= [[getVariable]] [[allVariables]] [[setFSMVariable]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
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]
+
<dt></dt>
<!-- Note Section END -->
+
<dd class="notedate">Posted on December 9, 2015 - 20:18 (UTC)</dd>
 +
<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>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|SETVARIABLE]]
 
[[Category:Scripting Commands OFP Elite |SETVARIABLE]]
 
[[Category:Scripting Commands ArmA|SETVARIABLE]]
 

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.