setVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(example)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(102 intermediate revisions by 12 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]]
* [[Object]] setVariable [[Array]]
* [[Group]] setVariable [[Array]]
* [[Team_Member]] setVariable [[Array]]
* [[Task]] setVariable [[Array]]
* [[Location]] setVariable [[Array]]|= Description
____________________________________________________________________________________________


| objectName '''setVariable''' [name, value, (public)] |= Syntax
|arg= global


|p1= objectName: [[Object]] or [[Location]]. Arma 2 also supports: [[Namespace]], [[Group]], [[Control]], [[Task]] |= Parameter 1
|eff= local
|p2= [name, value]: [[Array]] |= Parameter 2
|p3= name: [[String]] |= Parameter 3
|p4= value: [[Any_Value]] |= Parameter 4
|p5= public: [[Boolean]] - Only available for [[Object]] types. If public is true then the value is broadcast to all computers. |= Parameter 5


| [[Nothing]] |= Return value
|gr1= Variables
____________________________________________________________________________________________


|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]<nowiki>]</nowiki>;</code> |= Example 1
|gr2= Namespaces


|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]]<nowiki>]</nowiki>;</code> |= Example 2
|gr3= Multiplayer


|x3= <code>[[missionNamespace]] [[setVariable]] ["myName", "KK"];
|descr= Set variable to given value in the variable space of given element. Can be used to broadcast variables over the network.<br>
[[hint]] [[str]] myName; //KK</code> |= Example 3
To remove a variable, set it to [[nil]] (see {{Link|#Example 5}}) - note that this does not work on [[Object]] and [[createLocation|scripted]] [[Location]] namespaces (the variable will be set to [[nil]] but will remain listed by [[allVariables]]).


|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.  
{{Feature|warning|
<br>
[[missionNamespace]], [[uiNamespace]], [[parsingNamespace]] and [[profileNamespace]] variables '''cannot''' be named as commands - e.g <sqf inline>missionNamespace setVariable ["west", 123];</sqf> conflicts with the [[west]] command and will result in a {{hl|Reserved variable in expression}} error, [[west]] being a scripting command (other namespaces do not have such limitation).
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
See also [[:Category:Scripting Commands|all available script commands]].
}}


| [[6thSense.eu:EG|MP editing guide]], [[getVariable]] |= See also
|s1= varspace [[setVariable]] [name, value, public]


|p1= varspace: variable space in which variable can be set. Can be one of:
{{Columns|2|
* [[Namespace]]
* [[Object]]
** {{Icon|checked}} {{GVI|arma3|2.10|size= 0.75}} {{hl|CfgAmmo}} [[Object]]s (bullets, mines etc)
** {{Icon|unchecked}} {{hl|CfgNonAIVehicles}} [[Object]]s (butterflies, proxies etc - {{hl|EmptyDetector}}s (triggers) work)
** {{Icon|unchecked}} {{hl|#local}} [[Object]]s ({{hl|#lightpoint}}, {{hl|#soundsource}} etc - see [[createVehicleLocal]])
* [[Group]]
* [[Location]] ({{GVI|arma3|2.10|size= 0.75}} [[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]]
}}
}}


<h3 style="display:none">Notes</h3>
|p2= name: [[String]] - variable name ([[Identifier]])
<dl class="command_description">
<!-- Note Section BEGIN -->
<dt class="note">Unknown
<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]
|p3= value: [[Anything]] - variable value


|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]]


<dd class="notedate">Posted on 3 November, 2009 - 19:40 (CEST)
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:
<dt class="note">[[User:WGL.Q|.kju]]
{{{!}} class="wikitable align-center"
<dd class="note">Public variable parameter works also for groups in ArmA II. [http://dev-heaven.net/issues/show/5542 Ref: A2 CIT].
! Type
{{!}} [[Number]]
{{!}} [[Boolean]]
{{!}} [[Object]]
{{!}} [[Group]]
{{!}} [[String]]
{{!}} [[Structured Text|Text]]
{{!}} [[Array]]
{{!}} [[Code]]
{{!}} [[Nothing]] ([[nil]])
{{!}} [[HashMap]]
{{!}}-
! Since
{{!}} colspan="6" {{!}} {{GVI|arma1|1.00}}
{{!}} colspan="2" {{!}} {{GVI|arma1|1.09}}
{{!}} {{GVI|arma3|1.26}}
{{!}} {{GVI|arma3|2.02}}
{{!}}}
|p4since= arma2 1.00


|r1= [[Nothing]]


<dd class="notedate">Posted on January 18, 2010 - 17:27 (CEST)
|x1= <sqf>_myTruck setVariable ["TAG_myPublicVariable", 123, true];</sqf>
<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)
|x2= <sqf>_myTruck setVariable ["TAG_myLocalVariable", ["321", _var], owner driver _myTruck];</sqf>
<dt class="note">'''[[User:LaKing|LaKing]]'''
<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)
|x3= <sqf>
<dt class="note">'''[[User:Lou Montana|Lou Montana]]'''
missionNamespace setVariable ["TAG_myName", "Brian"];
<dd class="note">this command '''does''' work with [[createSimpleTask|tasks]] in '''Arma 2 OA 1.57'''
hint TAG_myName; // hints "Brian"
</sqf>


<dd class="notedate">Posted on 19 July, 2011
|x4= Get the current value of a variable or, if it is undefined, define it and then get the value:
<dt class="note">[[User:kju|kju]]
<sqf>
<dd class="note">My finds with 1.59 are:
private _var = missionNamespace getVariable "VarName";
* not working for [[Task]] (example anyone?)
if (isNil "_var") then
* public is JIP synced for [[Object]] and [[Group]]
{
* public parameter is not available for [[Namespace]], [[Location]] (, [[Task]])
_var = 123;
missionNamespace setVariable ["VarName", _var];
};
// _var now contains the current value of the missionNamespace's variable varName
</sqf>


<dd class="notedate">Posted on 8 May, 2012
|x5= Remove {{hl|TAG_myPublicVariable}} from [[missionNamespace]] (globally):
<dt class="note">[[User:Krause|Krause]]  
<sqf>missionNamespace setVariable ["TAG_myPublicVariable", nil, true];</sqf>
<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 -->
|seealso= [[getVariable]] [[allVariables]] [[setFSMVariable]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= Killswitch
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
|timestamp= 20070818095100
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
|text= According to {{User|Suma}}, beginning with {{Name|arma1|short}} version 1.08:
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]
{{Feature|quote|
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[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.
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
'''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.
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
| {{User|Suma}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
| Talk:setVariable#setVariable local or global in Multiplayer}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Commy2
<dd class="notedate">Posted on June 13, 2014 - 19:19 (UTC)</dd>
|timestamp= 20151209201800
<dt class="note">'''[[User:Astus Darkblossom|Astus Darkblossom]]'''</dt>
|text= This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.
<dd class="note">
}}
Arma 3 SPOTREP #00024


Added: Possibility to 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.
{{Note
</dd>
|user= Leopard20
</dl>
|timestamp= 20220323085950
<!-- DISCONTINUE Notes -->
|text= Since {{GVI|arma3|2.10}} [[setVariable]] works on CfgAmmo objects (such as bullets, missiles, grenades, mines, etc) as well.
}}

Latest revision as of 19:43, 3 September 2024

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) - note that this does not work on Object and scripted Location namespaces (the variable will be set to nil but will remain listed by allVariables).
missionNamespace, uiNamespace, parsingNamespace and profileNamespace variables cannot be named as commands - e.g missionNamespace setVariable ["west", 123]; conflicts with the west command and will result in a Reserved variable in expression error, west being a scripting command (other namespaces do not have such limitation). See also all available script commands.
Groups:
VariablesNamespacesMultiplayer

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 Logo A2.png1.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 A1 black.png1.00 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's variable varName
Example 5:
Remove TAG_myPublicVariable from missionNamespace (globally):
missionNamespace 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
Killswitch - c
Posted on Aug 18, 2007 - 09:51 (UTC)
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. » – Suma (source)
Commy2 - c
Posted on Dec 09, 2015 - 20:18 (UTC)
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.
Leopard20 - c
Posted on Mar 23, 2022 - 08:59 (UTC)
Since Arma 3 logo black.png2.10 setVariable works on CfgAmmo objects (such as bullets, missiles, grenades, mines, etc) as well.