BIS fnc removeIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
m (Some wiki formatting)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 15: Line 15:
|gr1= Arrays
|gr1= Arrays


|Takes an array, and returns a new array with the specified index(es)
|descr= Takes an array, and returns a new array with the specified index(es) removed.
removed.
This takes the array passed in the first parameter, and returns an array that has the index number in the second parameter 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.
If a third parameter is passed, then a range of indexes will be removed.
Alternatively, an array of indices to remove can be passed in the second parameter.


Alternatively, you can pass an array of indexes to remove in the
{{Feature|arma3|Use [[deleteAt]] or [[deleteRange]] instead.}}
second parameter.
{{Feature|arma3|Use [[deleteAt]] or [[deleteRange]] instead}}


| [array,startIndex,endIndex] call [[BIS_fnc_removeIndex]]
|s1= [array, startIndex, endIndex] call [[BIS_fnc_removeIndex]]


|p1=array: [[Array]]
|p1= array: [[Array]]


|p2=startIndex: [[Number]] - Start index to be removed, if parameter 3 isn't provided, only this index is removed
|p2= startIndex: [[Number]] - start index to be removed, if {{Link|#Parameter 3}} is not provided, only this index is removed


|p3=endIndex: [[Number]] - (Optional, default [[Nothing]]) -  End index, if provided the indexs from startIndex to endIndex will be removed
|p3= endIndex: [[Number]] - (Optional, default [[Nothing]]) -  end index, if provided the indexs from startIndex to endIndex will be removed


| [[Array]] - New array with new values
|r1= [[Array]] - new array with new values


|s2= [array,indexes] call [[BIS_fnc_removeIndex]]
|s2= [array, indices] call [[BIS_fnc_removeIndex]]


|p21=array: [[Array]]
|p21= array: [[Array]]


|p22=indexes: [[Array]] of [[Number|numbers]] - Indexes to be removed
|p22= indices: [[Array]] of [[Number]]s - indices to be removed


|r2= [[Array]] - New array with new values
|r2= [[Array]] - new array with new values


|x1= <code>_array = [0,1,2,3,4];
|x1= <sqf>
[array,0] [[call]] BIS_fnc_removeIndex;//Returns [1,2,3,4]</code>
private _array = [0,1,2,3,4];
[array, 0] call BIS_fnc_removeIndex; // returns [1,2,3,4]
</sqf>


|x2= <code>_array = [0,1,2,3,4];
|x2= <sqf>
[array,0,4] [[call]] BIS_fnc_removeIndex;//Returns []</code>
private _array = [0,1,2,3,4];
[_array, 0, 4] call BIS_fnc_removeIndex; // returns []
</sqf>


|x3= <code>_array = [0,1,2,3,4];
|x3= <sqf>
[array,[0,4]] [[call]] BIS_fnc_removeIndex;//Returns [1,2,3]</code>
private _array = [0,1,2,3,4];
[_array, [0,4]] call BIS_fnc_removeIndex; // returns [1,2,3]
</sqf>


|seealso= [[deleteAt]], [[deleteRange]]
|seealso= [[deleteAt]] [[deleteRange]]
}}
}}
[[Category:{{Name|arma2}}: Functions|{{uc:removeIndex}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:removeIndex}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:removeIndex}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeIndex}}]]

Latest revision as of 11:34, 1 July 2022

Logo 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:
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, an array of indices to remove can be passed in the second parameter.
Arma 3
Use deleteAt or deleteRange instead.
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 is not 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, indices] call BIS_fnc_removeIndex
Parameters:
array: Array
indices: Array of Numbers - indices 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:
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=BIS_fnc_removeIndex&oldid=323162"