set: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "$1$2</code>")
m (Replaced <code> with <sqf>)
(9 intermediate revisions by one other user not shown)
Line 53: Line 53:
|r2= [[Boolean]] - [[false|False]] if the key is new to the hashmap, [[true]] if a value got overwritten
|r2= [[Boolean]] - [[false|False]] if the key is new to the hashmap, [[true]] if a value got overwritten


|x1= <code>_arrayOne set [0, "Hello"];</code>
|x1= <sqf>_arrayOne set [0, "Hello"];</sqf>


|x2= Append "Bye" as last element to {{hl|_arrayTwo}}:
|x2= Append "Bye" as last element to {{hl|_arrayTwo}}:
<code>_arrayTwo set [<nowiki/>count _arrayTwo, "Bye"];</code>
<sqf>_arrayTwo set [count _arrayTwo, "Bye"];</sqf>


|x3= Replace the last element of {{hl|_arrayThree}} with 23:
|x3= Replace the last element of {{hl|_arrayThree}} with 23:
<code>_arrayThree set [<nowiki/>(count _arrayThree) - 1, 23];</code>
<sqf>_arrayThree set [(count _arrayThree) - 1, 23];</sqf>


|x4= Using [[set]] with an index that is out of bounds:
|x4= Using [[set]] with an index that is out of bounds:
<code>[[private]] _array = ["A"];
<sqf>private _array = ["A"];
_array [[set]] [2, "C"]; // _array is now ["A", [[nil]], "C"]
_array set [2, "C"]; // _array is now ["A", nil, "C"]
_array [[set]] [1, "B"]; // _array is now ["A", "B", "C"]
_array set [1, "B"]; // _array is now ["A", "B", "C"]</sqf>
</code>


|x5= <code>[[private]] _myHashMap = [[createHashMap]];
|x5= <sqf>private _myHashMap = createHashMap;
_myHashMap [[set]] ["key", "value1", [[true]]]; // "key" value is set to "value1"
_myHashMap set ["key", "value1", true]; // "key" value is set to "value1"
_myHashMap set ["key", "value2", [[true]]]; // "key" value is still "value1" as "key" already exists in the hashmap</code>
_myHashMap set ["key", "value2", true]; // "key" value is still "value1" as "key" already exists in the hashmap</sqf>


|seealso= [[resize]] [[reverse]] [[select]] [[deleteAt]] [[deleteRange]]  
|seealso= [[resize]] [[reverse]] [[select]] [[deleteAt]] [[deleteRange]]  
}}
}}

Revision as of 16:43, 14 May 2022

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Changes the element at the given zero-based index of the array. If the index is out of bounds, the array will resize to incorporate the index as its last value, padding with nil as necessary (see Example 4).
Groups:
ArraysHashMap

Syntax

Syntax:
array set [index, value]
Parameters:
array: Array
index: Number
value: Anything
Return Value:
Nothing

Alternative Syntax

Syntax:
hashMap set [key, value, insertOnly]
Parameters:
hashMap: HashMap
key: HashMapKey
value: Anything
since Arma 3 logo black.png2.08
insertOnly: Boolean - (Optional, default false) if set to true, set the value only if the key does not exist already
Return Value:
Boolean - False if the key is new to the hashmap, true if a value got overwritten

Examples

Example 1:
_arrayOne set [0, "Hello"];
Example 2:
Append "Bye" as last element to _arrayTwo:
_arrayTwo set [count _arrayTwo, "Bye"];
Example 3:
Replace the last element of _arrayThree with 23:
_arrayThree set [(count _arrayThree) - 1, 23];
Example 4:
Using set with an index that is out of bounds:
private _array = ["A"]; _array set [2, "C"]; // _array is now ["A", nil, "C"] _array set [1, "B"]; // _array is now ["A", "B", "C"]
Example 5:
private _myHashMap = createHashMap; _myHashMap set ["key", "value1", true]; // "key" value is set to "value1" _myHashMap set ["key", "value2", true]; // "key" value is still "value1" as "key" already exists in the hashmap

Additional Information

See also:
resize reverse select deleteAt deleteRange

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
Retrieved from "https://community.bistudio.com/wiki?title=set&oldid=321450"