setVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
m (Text replacement - "{{EffArg|cmd|eff|glob}}" to "{{Icon|globalEffect|32}}")
Line 49: Line 49:
|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)
|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 {{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
* [[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

Revision as of 23:31, 25 January 2021

Hover & click on the images for description

Description

Description:
Description needed
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:
MultiplayerVariables

Syntax

Syntax:
Syntax needed
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:
Return value needed

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:
See also needed

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.