setVariable: Difference between revisions
Jump to navigation
Jump to search
(add. ArmA2 classification) |
Dr Eyeball (talk | contribs) (MP public param, new types supported) |
||
Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Set variable to given value in the variable space of given | | 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]). |= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| objectName '''setVariable''' [name, value] |= Syntax | | objectName '''setVariable''' [name, value, (public)] |= Syntax | ||
|p1= objectName: [[Object]] or [[Location]] |= Parameter 1 | |p1= objectName: [[Object]] or [[Location]]. Arma 2 also supports: [[Namespace]], [[group]], [[Control|map control]], [[Task]] |= Parameter 1 | ||
|p2= [name, value]: [[Array]] |= Parameter 2 | |p2= [name, value]: [[Array]] |= Parameter 2 | ||
|p3= name: [[String]] |= Parameter 3 | |p3= name: [[String]] |= Parameter 3 | ||
|p4= value: [[Any_Value]] |= Parameter 4 | |p4= value: [[Any_Value]] |= Parameter 4 | ||
|p5= public: [[Boolean]] - Only available for [[Object]] types. If public is true then the value is broadcast to all computers. |= Parameter 5 | |||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_myTruck setVariable ["myVariable",123];</code> |= Example 1 | |x1= <code>_myTruck setVariable ["myVariable", 123, true];</code> |= Example 1 | ||
|mp= In MP, the variable space of the object is local to each client. Changes are not broadcast, except in Arma 2 via public parameter for supported types. |= Multiplayer | |||
| [[getVariable]], [[setVariable (VBS2)]] |= See also | | [[getVariable]], [[setVariable (VBS2)]] |= See also |
Revision as of 06:34, 19 July 2009
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]).
- Multiplayer:
- In MP, the variable space of the object is local to each client. Changes are not broadcast, except in Arma 2 via public parameter for supported types.
- Groups:
- Uncategorised
Syntax
- Syntax:
- objectName setVariable [name, value, (public)]
- Parameters:
- objectName: Object or Location. Arma 2 also supports: Namespace, group, map control, Task
- [name, value]: Array
- name: String
- value: Any_Value
- public: Boolean - Only available for Object types. If public is true then the value is broadcast to all computers.
- Return Value:
- Nothing
Examples
- Example 1:
_myTruck setVariable ["myVariable", 123, true];
Additional Information
- See also:
- getVariablesetVariable (VBS2)
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
-
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: Make setVariable work on other things than just vehicles
Bottom Section
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 ArmA
- Command Group: Locations
- Command Group: Object Information
- Command Group: Variables
- Scripting Commands ArmA2