deleteAt: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|gr2= HashMap |GROUP2= | |gr2= HashMap |GROUP2= | ||
| Removes array element at the given index and returns removed element (modifies the original array, just like [[resize]] or [[set]]). Will not issue error when -1 index is passed making it ideal for using with [[find]](see Example 2) or [[findIf]](see Example 3) command |DESCRIPTION= | | Removes array element at the given index and returns removed element (modifies the original array, just like [[resize]] or [[set]]). Will not issue error when -1 index is passed making it ideal for using with [[find]](see Example 2) or [[findIf]](see Example 3) command |DESCRIPTION= | ||
| array '''deleteAt''' index |SYNTAX= | | array '''deleteAt''' index |SYNTAX= | ||
| Line 21: | Line 18: | ||
| [[Anything]] - returns the deleted element |RETURNVALUE= | | [[Anything]] - returns the deleted element |RETURNVALUE= | ||
| s2= hashMap [[deleteAt]] key |SYNTAX4= | | s2= hashMap [[deleteAt]] key |SYNTAX4= | ||
| Line 29: | Line 25: | ||
| r2= [[Anything]] |RETURNVALUE2= | | r2= [[Anything]] |RETURNVALUE2= | ||
|x1= <code>_arr = [1,2,3]; | |x1= <code>_arr = [1,2,3]; | ||
| Line 47: | Line 42: | ||
[[hint]] [[str]] _arr; // [1,3]</code> |EXAMPLE3= | [[hint]] [[str]] _arr; // [1,3]</code> |EXAMPLE3= | ||
| [[deleteRange]], [[set]], [[resize]], [[select]], [[in]], [[find]], [[findIf]], [[toArray]], [[toString]], [[forEach]], [[count]], [[pushBack]], [[pushBackUnique]], [[apply]], [[append]], [[sort]], [[param]], [[params]], [[arrayIntersect]], [[splitString]], [[joinString]] |SEEALSO= | | [[deleteRange]], [[set]], [[resize]], [[select]], [[in]], [[find]], [[findIf]], [[toArray]], [[toString]], [[forEach]], [[count]], [[pushBack]], [[pushBackUnique]], [[apply]], [[append]], [[sort]], [[param]], [[params]], [[arrayIntersect]], [[splitString]], [[joinString]] |SEEALSO= | ||
Revision as of 00:58, 17 January 2021
Description
- Description:
- Removes array element at the given index and returns removed element (modifies the original array, just like resize or set). Will not issue error when -1 index is passed making it ideal for using with find(see Example 2) or findIf(see Example 3) command
- Groups:
- ArraysHashMap
Syntax
- Syntax:
- array deleteAt index
- Parameters:
- array: Array
- index: Number
- Return Value:
- Anything - returns the deleted element
Alternative Syntax
- Syntax:
- hashMap deleteAt key
- Parameters:
- hashMap: HashMap
- key : HashMapKey
- Return Value:
- Anything
Examples
- Example 1:
_arr = [1,2,3]; _rem = _arr deleteAt 1; hint str [_rem, _arr]; //[2,[1,3]]- Example 2:
_arr = [1,2,3]; _arr deleteAt (_arr find 0); // non existent item hint str _arr; // [1,2,3] _arr deleteAt (_arr find 2); // existent item hint str _arr; // [1,3]- Example 3:
_arr = [1,2,3]; _arr deleteAt (_arr findIf {(_x % 5) == 0}); // Remove first number that's divisible by 5 hint str _arr; // [1,2,3] _arr deleteAt (_arr findIf {(_x % 2) == 0}); // Remove first number that's divisible by 2 hint str _arr; // [1,3]
Additional Information
- See also:
- deleteRangesetresizeselectinfindfindIftoArraytoStringforEachcountpushBackpushBackUniqueapplyappendsortparamparamsarrayIntersectsplitStringjoinString
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
Bottom Section
- Posted on October 15, 2014 - 16:55 (UTC)
- Heeeere's Johnny!
-
_array deleteAt 0is almost 60x faster than_array = _array - [_array select 0](Tested with an array of 10.000 strings, iterating through it using a for-from-to-do loop)
- Posted on March 4, 2016 - 15:58 (UTC)
- Highhead
- Deleting from an array with foreach and _foreachIndex variable is tricky. The array is being altered, the _foreachIndex won't keep up and other elements in the array will be skipped and in worst case not being deleted. If you delete elements from an array in descending order (using while or for) it will work.
- Posted on February 9, 2017 - 22:45 (UTC)
- Igneous01
-
To expand on Highheads comment above - this is because forEach implements iterators to traverse a collection, which are read only by definition.
The variable _x is an iterator that points to the current item in the collection. Trying to alter _x will have no effect.
ARRAY = [1,2,3,4,5,6,7,8]; { _x = 2; } forEach ARRAY // ARRAY is still [1,2,3,4,5,6,7,8]When trying to use deleteAt inside forEach, the behaviour would be undefined as you are invalidating the iterator reference, and it will not know how to traverse to the next element. In short, only use forEach when reading data from an array. For more info about iterators, see C++ Iterators.
- Posted on October 3, 2019 - 13:16 (UTC)
- Tankbuster
- The index you pass to this command is zero based. The first element is number 0 and the second is 1 etc