BIS_fnc_removeIndex

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 2 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

Description

Description:
Takes an array, and returns a new array with the specified index(es) removed. This takes the array passed in the first parameter, and returns an array that has the index number in the second parameter removed. If a third parameter is passed, then a range of indexes will be removed. Alternatively, you can pass an array of indexes to remove in the second parameter.
Arma 3 logo black.png
Use deleteAt or deleteRange instead

Syntax

Syntax:
[array,startIndex,endIndex] call BIS_fnc_removeIndex
Parameters:
array: Array
startIndex: Number - Start index to be removed, if parameter 3 isn't provided, only this index is removed
endIndex: Number - (Optional, default Nothing) - End index, if provided the indexs from startIndex to endIndex will be removed
Return Value:
Array - New array with new values

Alternative Syntax

Syntax:
[array,indexes] call BIS_fnc_removeIndex
Parameters:
array: Array
indexes: Array of numbers - Indexes to be removed
Return Value:
Array - New array with new values

Examples

Example 1:
_array = [0,1,2,3,4]; [array,0] call BIS_fnc_removeIndex;//Returns [1,2,3,4]
Example 2:
_array = [0,1,2,3,4]; [array,0,4] call BIS_fnc_removeIndex;//Returns []
Example 3:
_array = [0,1,2,3,4]; [array,[0,4]] call BIS_fnc_removeIndex;//Returns [1,2,3]

Additional Information

Execution:
call
Multiplayer:
-
See also:
deleteAtdeleteRange

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section