set: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix hashmap return value)
m (Some wiki formatting)
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofpr |Game name=
|game1= ofp
|version1= 1.75


|1.75|Game version=
|game2= ofpe
|version2= 1.00


|gr1= Arrays |GROUP1=
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Changes the element at the given (zero-based) index of the [[Array|array]].<br>
|game4= arma2
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 [[set#Examples| Example 4]]. |DESCRIPTION=
|version4= 1.00
____________________________________________________________________________________________


| array '''set''' [index, value] |SYNTAX=
|game5= arma2oa
|version5= 1.50


|p1= array: [[Array]] |PARAMETER1=
|game6= tkoh
|p2= [index, value]: [[Array]] |PARAMETER2=
|version6= 1.00
|p3= index: [[Number]] |PARAMETER3=
|p4= value: [[Anything]] |PARAMETER4=


| [[Nothing]] |RETURNVALUE=
|game7= arma3
|version7= 0.50


____________________________________________________________________________________________
|gr1= Arrays


| s2= hashMap '''set''' [key, value] |SYNTAX2=
|gr2= HashMap


|p21= hashMap : [[HashMap]] |PARAMETER21=
|descr= Changes the element at the given zero-based index of the [[Array|array]].
|p22= key: [[HashMapKey]] |PARAMETER23=
|p23= value: [[Anything]] |PARAMETER24=


|r2= [[Boolean]] - [[false]] if the key is new to the hashmap, [[true]] if a value got overwritten |RETURNVALUE2=
{{Feature|informative|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 {{Link|#Example 4}}). }}
____________________________________________________________________________________________
 
|x1= <code>_arrayOne [[set]] [0, "Hello"];</code> |EXAMPLE1=


|x2= Append "Bye" as last element to <tt>_arrayTwo</tt>:<br>
|s1= array [[set]] [index, value]
<code>_arrayTwo [[set]] [<nowiki/>[[count]] _arrayTwo, "Bye"];</code> |EXAMPLE2=


|x3= Replace the last element of <tt>_arrayThree</tt> with 23:<br>
|p1= array: [[Array]]
<code>_arrayThree [[set]] [<nowiki/>([[count]] _arrayThree) - 1, 23];</code> |EXAMPLE3=


|x4 = Using [[set]] with an index that is out of bounds:<br>
|p2= index: [[Number]] - 0-based array index. {{GVI|arma3|2.12|size= 0.75}} negative index can be used to select from the end of the array, i.e. -1 means last array element.
<code>_array = ["A"];
_array [[set]] [2, "C"]; {{cc|_array is now ["A", [[nil]], "C"]}}
_array [[set]] [1, "B"]; {{cc|_array is now ["A", "B", "C"]}}
</code> |EXAMPLE4=
____________________________________________________________________________________________


| [[Array]], [[plus a]], [[valuea plus valueb]], [[a - b]], [[resize]], [[reverse]], [[select]], [[in]], [[find]], [[findIf]], [[toArray]], [[toString]], [[forEach]], [[count]], [[pushBack]], [[pushBackUnique]], [[apply]], [[deleteAt]], [[deleteRange]], [[append]], [[sort]], [[param]], [[params]], [[arrayIntersect]], [[splitString]], [[joinString]]|SEEALSO=
|p3= value: [[Anything]]


}}
|r1= [[Nothing]]
 
|s2= hashMap [[set]] [key, value, insertOnly]
 
|s2since= arma3 2.02
 
|p21= hashMap: [[HashMap]]
 
|p22= key: [[HashMapKey]]
 
|p23= value: [[Anything]]
 
|p24= insertOnly: [[Boolean]] - (Optional, default [[false]]) if set to [[true]], set the value only if the key does not exist already
|p24since= arma3 2.08
 
|r2= [[Boolean]] - [[false]] if the key is new to the hashmap, [[true]] if a value got overwritten
 
|x1= <sqf>_arrayOne set [0, "Hello"];</sqf>
 
|x2= Append "Bye" as last element to {{hl|_arrayTwo}}:
<sqf>_arrayTwo set [count _arrayTwo, "Bye"];</sqf>
 
|x3= Replace the last element of {{hl|_arrayThree}} with 23:
<sqf>_arrayThree set [(count _arrayThree) - 1, 23];</sqf>


<h3 style="display:none">Notes</h3>
|x4= Using [[set]] with an index that is out of bounds:
<dl class="command_description">
<sqf>
<!-- Note Section BEGIN -->
private _array = ["A"];
_array set [2, "C"]; // _array is now ["A", nil, "C"]
_array set [1, "B"]; // _array is now ["A", "B", "C"]
</sqf>


<!-- Note Section END -->
|x5= <sqf>
</dl>
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
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[resize]] [[reverse]] [[select]] [[deleteAt]] [[deleteRange]]  
[[Category:Scripting Commands|SET]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SET]]
[[Category:Scripting Commands Armed Assault|SET]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 20:21, 29 April 2023

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 - 0-based array index. Arma 3 logo black.png2.12 negative index can be used to select from the end of the array, i.e. -1 means last array element.
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=340315"