setVariable: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (outdated notes removed) |
Lou Montana (talk | contribs) m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|") |
||
(17 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma | | | arma |Game name= | ||
|1.00| | |1.00|Game version= | ||
|arg= global| | |arg= global|Arguments in MP= | ||
|eff= local | | |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]] | ||
* [[Object]] | |||
* [[Namespace | * [[Group]] | ||
* [[Object | * [[Team Member]] | ||
* [[Group | * [[Task]] (FSM Task) | ||
* [[ | * [[Location]] (only [[createLocation | scripted]] locations) | ||
* [[Task]] | * [[Control]] (since Arma 3 v1.55.133553) | ||
* [[Location]] | * [[Display]] (since Arma 3 v1.55.133553) | ||
* [[Control | |||
* [[Display | |||
{{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]], [[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 | | 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 | | |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]] | | |p2= [name, value]: [[Array]] |Parameter 2= | ||
|p3= name: [[String]] - variable name| | |p3= name: [[String]] - variable name |Parameter 3= | ||
|p4= value: [[Anything]] - variable value | | |p4= value: [[Anything]] - variable value |Parameter 4= | ||
| [[Nothing]] | | | [[Nothing]] |Return value= | ||
| s2 = varspace | | s2 = varspace [[setVariable]] [name, value, public] |Syntax 2= | ||
|p21= varspace: [[missionNamespace]] or [[ | |p21= varspace: [[missionNamespace]], [[Object]] or [[Group]] - variable space in which variable can be set |Parameter 21= | ||
|p22= [name, value, public]: [[Array]] |= | |p22= [name, value, public]: [[Array]] |Parameter 22= | ||
|p23= name: [[String]] - variable name |= | |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) |= | |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 |= | * [[Array]] of [[Number]]s - array of [[owner]] ([[clientOwner]]) ids |Parameter 25= | ||
| r2=[[Nothing]] | | |r2= [[Nothing]] |Return value 2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]] | |x1= <code>_myTruck [[setVariable]] ["myPublicVariable", 123, [[true]]];</code> |Example 1= | ||
|x2= <code>_myTruck [[setVariable]] ["myLocalVariable", ["321", _var], [[false]] | |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> | | [[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> | | // _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. | | |||
| [[getVariable]], [[allVariables]], [[setFSMVariable]], [[Multiplayer Scripting#Join In Progress|Multiplayer Scripting]]|See also= | |||
}} | }} | ||
<h3 style="display:none">Notes</h3> | <h3 style="display:none">Notes</h3> | ||
<dl class="command_description"> | <dl class="command_description"> | ||
</dl> | </dl> | ||
Line 105: | Line 84: | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands | [[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
<!-- CONTINUE Notes --> | <!-- CONTINUE Notes --> | ||
Line 128: | Line 97: | ||
<dt class="note">[[User:Commy2|Commy2]]</dt> | <dt class="note">[[User:Commy2|Commy2]]</dt> | ||
<dd class="note"> | <dd class="note"> | ||
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies. | This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies (probably because they are [[local]] objects [[User:Killzone Kid|Killzone Kid]] ([[User talk:Killzone Kid|talk]]) 11:25, 9 July 2017 (CEST)). | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
<!-- DISCONTINUE Notes --> | <!-- DISCONTINUE Notes --> |
Revision as of 20:42, 3 June 2020
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:- Namespace
- Object
- Group
- Team Member
- Task (FSM Task)
- Location (only scripted locations)
- Control (since Arma 3 v1.55.133553)
- Display (since Arma 3 v1.55.133553)
- 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. - Groups:
- Uncategorised
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
- Boolean - when true, the variable broadcast is global and persistent Template:EffArg
- 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 Numbers - array of owner (clientOwner) ids
- 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
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
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)).
Categories:
- Scripting Commands
- Introduced with Arma version 1.00
- Arma: New Scripting Commands
- Arma: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Local Effect
- Scripting Commands OFP Elite
- Scripting Commands Armed Assault
- Command Group: Locations
- Command Group: Object Information
- Command Group: Variables
- Scripting Commands Arma 2
- Scripting Commands Take On Helicopters
- Scripting Commands Arma 3