Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (The global effect is already listed at the respective parameter)
(only scripted locations)
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma |= Game name
+
| arma |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
  
|arg= global|= Arguments in MP
+
|arg= global|Arguments in MP=
|eff= local |= Effects in MP
+
|eff= local |Effects in MP=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Set variable to given value in the variable space of given element.
+
| Set variable to given value in the variable space of given element.<br />
<br>
+
To remove a variable, set it to [[nil]] (e.g. {{Inline code|[[player]] [[setVariable]] ["varname", [[nil]]<nowiki>]</nowiki>;}}).<br />
To remove a variable, set it to [[nil]] (e.g. {{Inline code|[[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.<br>
<br>
+
When variable is set on [[Location]], it works only with locations created with [[createLocation]].<br>
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.
+
All supported variable types:
<br>
+
* [[Namespace]]
All available variable spaces which support [[setVariable]]:
+
* [[Object]]
* [[Namespace]] setVariable [[Array]]
+
* [[Group]]
* [[Object]] setVariable [[Array]]
+
* [[Team Member]]
* [[Group]] setVariable [[Array]]
+
* [[Task]] (FSM Task)
* [[Team_Member]] setVariable [[Array]]
+
* [[Location]] (only [[createLocation | scripted]] locations)
* [[Task]] setVariable [[Array]]
+
* [[Control]] (since Arma 3 v1.55.133553)
* [[Location]] setVariable [[Array]]
+
* [[Display]] (since Arma 3 v1.55.133553)
* [[Control]] setVariable [[Array]] (since Arma 3 v1.55.133553)
 
* [[Display]] setVariable [[Array]] (since Arma 3 v1.55.133553)
 
  
{{Feature arma3|In Arma 3 it is possible to broadcast [[nil]] value}}|= Description
+
{{Feature arma3|In Arma 3 it is possible to broadcast [[nil]] value}}
 +
{{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 position: <setVariable ["west", 123];>
 +
    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]]}} |Description=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| varspace '''setVariable''' [name, value] |= Syntax 1
+
| varspace [[setVariable]] [name, value] |Syntax 1=
  
|p1= varspace: [[Namespace]], [[Object]], [[Group]], [[Team_Member]], [[Task]], [[Location]], [[Control]], [[Display]] - variable space in which variable can be set |= Parameter 1
+
|p1= varspace: [[Namespace]], [[Object]], [[Group]], [[Team_Member]], [[Task]], [[Location]], [[Control]], [[Display]] - variable space in which variable can be set |Parameter 1=
|p2= [name, value]: [[Array]] |= Parameter 2
+
|p2= [name, value]: [[Array]] |Parameter 2=
|p3= name: [[String]] - variable name|= Parameter 3
+
|p3= name: [[String]] - variable name |Parameter 3=
|p4= value: [[Anything]] - variable value |= Parameter 4
+
|p4= value: [[Anything]] - variable value |Parameter 4=
  
| [[Nothing]] |= Return value
+
| [[Nothing]] |Return value=
  
| s2 = varspace '''setVariable''' [name, value, public] |= Syntax 1
+
| s2 = varspace [[setVariable]] [name, value, public] |Syntax 2=
  
|p21= varspace: [[missionNamespace]], [[Object]] or [[Group]] - variable space in which variable can be set |= Parameter 1
+
|p21= varspace: [[missionNamespace]], [[Object]] or [[Group]] - variable space in which variable can be set |Parameter 21=
|p22= [name, value, public]: [[Array]] |= Parameter 2
+
|p22= [name, value, public]: [[Array]] |Parameter 22=
|p23= name: [[String]] - variable name |= Parameter 3
+
|p23= name: [[String]] - variable name |Parameter 23=
|p24= value: [[Anything]] - variable value (if public is [[true]], check [[publicVariable]] for what types are supported for broadcast) |= Parameter 4
+
|p24= value: [[Anything]] - variable value (if public is [[true]], check [[publicVariable]] for what types are supported for broadcast) |Parameter 24=
 
|p25= public: [[Boolean]], [[Number]] or [[Array]] of [[Number]]s
 
|p25= public: [[Boolean]], [[Number]] or [[Array]] of [[Number]]s
 
* [[Boolean]] - when [[true]], the variable broadcast is global and persistent {{EffArg|cmd|eff|glob}}
 
* [[Boolean]] - when [[true]], the variable broadcast is global and persistent {{EffArg|cmd|eff|glob}}
 
* [[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
 
* [[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 |= Parameter 5
+
* [[Array]] of [[Number]]s - array of [[owner]] ([[clientOwner]]) ids |Parameter 25=
  
| r2=[[Nothing]] |= Return value
+
|r2= [[Nothing]] |Return value 2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]<nowiki>]</nowiki>;</code> |= Example 1
+
|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]];</code> |Example 1=
  
|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]]<nowiki>]</nowiki>;</code> |= Example 2
+
|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]]];</code> |Example 2=
  
 
|x3= <code>[[missionNamespace]] [[setVariable]] ["myName", "KK"];
 
|x3= <code>[[missionNamespace]] [[setVariable]] ["myName", "KK"];
[[hint]] myName; //KK</code> |= Example 3
+
[[hint]] myName; //KK</code> |Example 3=
  
 
|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 current value of a variable and if it is undefined, define it and get the defined value:<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "varName";
Line 65: Line 68:
 
_var = 123;
 
_var = 123;
 
};
 
};
// _var here will contain current value of the variable varName</code> |= Example 4
+
// _var here will contain current value of the variable varName</code> |Example 4=
  
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.  
+
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.<br />
<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=
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]], [[setFSMVariable]], [[6thSense.eu:EG|MP editing guide]]|= See also
 
  
 +
| [[getVariable]], [[allVariables]], [[setFSMVariable]], [[Multiplayer Scripting#Join In Progress|Multiplayer Scripting]]|See also=
 
}}
 
}}
  
Line 88: Line 89:
 
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
  
 
<!-- CONTINUE Notes -->
 
<!-- CONTINUE Notes -->

Revision as of 18:39, 15 November 2019

Introduced with Armed Assault version 1.001.00Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Set variable to given value in the variable space of given element.
To remove a variable, set it to nil (e.g. player setVariable ["varname", nil];).
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.
All supported variable types:
Arma 3 logo black.png
In Arma 3 it is possible to broadcast nil value
missionNamespace, uiNamespace, parsingNamespace and profileNamespace variable names could be any string, except for the reserved names, which are normally script command names. 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 script command. Other varspaces do not have such limitation. You can always check for all available script commands by running utility number 5
Multiplayer:
The variable space of the object is local to each client and by default changes are not broadcast.
Since Arma 2: If the public parameter for supported types is true, the value will be synchronized also for a JIP player.

Syntax

Syntax:
varspace setVariable [name, value]
Parameters:
varspace: Namespace, Object, Group, Team_Member, Task, Location, Control, Display - variable space in which variable can be set
[name, value]: Array
name: String - variable name
value: Anything - variable value
Return Value:
Nothing

Alternative Syntax

Syntax:
varspace setVariable [name, value, public]
Parameters:
varspace: missionNamespace, Object or Group - variable space in which variable can be set
[name, value, public]: Array
name: String - variable name
value: Anything - variable value (if public is true, check publicVariable for what types are supported for broadcast)
public: Boolean, Number or Array of Numbers
Return Value:
Nothing

Examples

Example 1:
_myTruck setVariable ["myPublicVariable", 123, true];
Example 2:
_myTruck setVariable ["myLocalVariable", ["321", _var], false];
Example 3:
missionNamespace setVariable ["myName", "KK"]; hint myName; //KK
Example 4:
Get current value of a variable and if it is undefined, define it and get the defined value:private _var = missionNamespace getVariable "varName"; if (isNil "_var") then { missionNamespace setVariable ["varName", 123]; _var = 123; }; // _var here will contain current value of the variable varName

Additional Information

See also:
getVariableallVariablessetFSMVariableMultiplayer Scripting

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section

Posted on December 9, 2015 - 20:18 (UTC)
Commy2
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies (probably because they are local objects Killzone Kid (talk) 11:25, 9 July 2017 (CEST)).