Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
 
(119 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.
____________________________________________________________________________________________
+
* To remove a variable, set it to [[nil]] (e.g. {{ic|[[player]] [[setVariable]] ["varname", [[nil]]<nowiki>]</nowiki>;}}).
|x1= <code>_myTruck setVariable ["myVariable",123];</code> |= Example 1
+
* 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]].
  
| [[getVariable]] |= See also
+
{{Feature|arma3|In Arma 3 it is possible to broadcast [[nil]] value!}}
  
 +
|mp= The variable space of the object is '''local to each client''' and '''by default''' changes are not broadcast.<br>
 +
Since Arma 2: '''If''' the '''public''' parameter for supported types is ''<tt>true</tt>'', the value will be '''synchronized''' also for a [[Multiplayer Scripting#Join In Progress|JIP]] player.
 +
 +
|pr= {{Feature | 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]]}}
 +
 +
|s1= varspace [[setVariable]] [name, value]
 +
 +
|p1= varspace: [[Namespace]], [[Object]], [[Group]], [[Team Member]], [[Task]], [[Location]], [[Control]], [[Display]] - Variable space in which variable can be set
 +
{{Feature|arma3|Since Arma 3 also [[Control]] and [[Display]] are supported types.}}
 +
|p2= name: [[String]] - Variable name
 +
 +
|p3= value: [[Anything]] - Variable value
 +
 +
|r1= [[Nothing]]
 +
 +
|s2= varspace [[setVariable]] [name, value, public]
 +
 +
|p21= varspace: [[missionNamespace]], [[Object]] or [[Group]] - Variable space in which variable can be set
 +
 +
|p22= name: [[String]] - Variable name
 +
 +
|p23= value: [[Anything]] - Variable value (if public is [[true]], check [[publicVariable]] for what types are supported for broadcast)
 +
 +
|p24= public: [[Boolean]], [[Number]] or [[Array]] of [[Number]]s
 +
* [[Boolean]] - When [[true]], the variable broadcast is global and persistent {{Icon|globalEffect|32}}
 +
 +
* [[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
 +
 +
|r2= [[Nothing]]
 +
 +
|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]];</code>
 +
 +
|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]]];</code>
 +
 +
|x3= <code>[[missionNamespace]] [[setVariable]] ["myName", "KK"];
 +
[[hint]] myName; {{cc|KK}}</code>
 +
 +
|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";
 +
[[if]] ([[isNil]] "_var") [[then]]
 +
{
 +
[[missionNamespace]] [[setVariable]] ["varName", 123];
 +
_var = 123;
 +
};
 +
{{cc|_var here will contain current value of the variable varName}}</code>
 +
 +
|seealso= [[getVariable]], [[allVariables]], [[setFSMVariable]], [[Multiplayer Scripting#Join In Progress|Multiplayer Scripting]]
 
}}
 
}}
  
<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 17:10, 13 June 2021

Hover & click on the images for description

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.
Arma 3
In Arma 3 it is possible to broadcast nil value!
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.
Problems:
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
Groups:
MultiplayerVariables

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
Arma 3
Since Arma 3 also Control and Display are supported types.
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: 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
  • 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
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

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.