Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
(only scripted locations)
(4 intermediate revisions by 2 users not shown)
Line 12: Line 12:
 
| Set variable to given value in the variable space of given element.<br />
 
| Set variable to given value in the variable space of given element.<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>;}}).<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.<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.<br>
 +
When variable is set on [[Location]], it works only with locations created with [[createLocation]].<br>
 
All supported variable types:
 
All supported variable types:
 
* [[Namespace]]
 
* [[Namespace]]
Line 18: Line 19:
 
* [[Group]]
 
* [[Group]]
 
* [[Team Member]]
 
* [[Team Member]]
* [[Task]]
+
* [[Task]] (FSM Task)
* [[Location]]
+
* [[Location]] (only [[createLocation | scripted]] locations)
 
* [[Control]] (since Arma 3 v1.55.133553)
 
* [[Control]] (since Arma 3 v1.55.133553)
 
* [[Display]] (since Arma 3 v1.55.133553)
 
* [[Display]] (since Arma 3 v1.55.133553)
  
 
{{Feature arma3|In Arma 3 it is possible to broadcast [[nil]] value}}
 
{{Feature arma3|In Arma 3 it is possible to broadcast [[nil]] value}}
{{Warning | [[missionNamespace]], [[uiNamespace]], [[uiNamespace]] 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:  
+
{{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 | utility number 5]]}} |Description=
+
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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  

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)).