set: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#|[A-Z]+))?\]\] " to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpr
|game1= ofp


|1.75
|version1= 1.75
 
|game2= ofpe
 
|version2= 1.00
 
|game3= arma1
 
|version3= 1.00
 
|game4= arma2
 
|version4= 1.00
 
|game5= arma2oa
 
|version5= 1.51
 
|game6= tkoh
 
|version6= 1.00
 
|game7= arma3
 
|version7= 0.50


|gr1= Arrays
|gr1= Arrays
Line 9: Line 33:
|gr2= HashMap
|gr2= HashMap


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


| array '''set''' [index, value]
|s1= array '''set''' [index, value]


|p1= array: [[Array]]
|p1= array: [[Array]]
|p2= [index, value]: [[Array]]
|p3= index: [[Number]]
|p4= value: [[Anything]]


| [[Nothing]]
|p2= index: [[Number]]


| s2= hashMap '''set''' [key, value]
|p3= value: [[Anything]]
 
|r1= [[Nothing]]
 
|s2= hashMap '''set''' [key, value] {{Since|arma3|2.02|y}}


|p21= hashMap : [[HashMap]]
|p21= hashMap : [[HashMap]]
|p22= key: [[HashMapKey]]
|p22= key: [[HashMapKey]]
|p23= value: [[Anything]]
|p23= value: [[Anything]]


|r2= [[Boolean]] - [[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= <code>_arrayOne [[set]] [0, "Hello"];</code>
Line 43: Line 69:
</code>
</code>


| [[Array]], [[plus a]], [[a plus b]], [[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= [[resize]] [[reverse]] [[select]] [[deleteAt]] [[deleteRange]]  
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 11:16, 27 March 2021

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh 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] Template:Since
Parameters:
hashMap : HashMap
key: HashMapKey
value: Anything
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:
_array = ["A"]; _array set [2, "C"]; // _array is now ["A", nil, "C"] _array set [1, "B"]; // _array is now ["A", "B", "C"]

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=251853"