BIS_fnc_removeIndex
Jump to navigation
Jump to search
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.
- Execution:
- call
- Groups:
- Arrays
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:
private _array = [0,1,2,3,4]; [array,0] call BIS_fnc_removeIndex;//Returns [1,2,3,4]
- Example 2:
private _array = [0,1,2,3,4]; [array,0,4] call BIS_fnc_removeIndex;//Returns []
- Example 3:
private _array = [0,1,2,3,4]; [array,[0,4]] call BIS_fnc_removeIndex;//Returns [1,2,3]
Additional Information
- See also:
- deleteAtdeleteRange
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