BIS fnc arrayInsert: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/************************************************************
|version4= 0.50
Array Insert


Parameters: [base array, insert array, index]
|gr1= Arrays
Returs: [array]


Inserts the elements of one array into another, at a specified
|descr= Inserts the elements of one array into another, at a specified index. Neither arrays are touched by reference, a new array is returned.
index.


Neither arrays are touched by reference, a new array is returned.
|s1= [array1, array2, index] call [[BIS_fnc_arrayInsert]]


Example: [[0,1,2,3,4], ["a","b","c"], 1] call BIS_fnc_arrayInsert
|p1= array1: [[Array]] - array to insert into
Returns: [0,"a","b","c",1,2,3,4]
************************************************************/


//extract parameters
|p2= array2: [[Array]] - array to be inserted
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_arrayInsert]]; --> |= Syntax
|p3= index: [[Number]] - insertion index


|p1= |= Parameter 1
|r1= [[Array]] - a new array


| |= Return value
|x1= <sqf>private _result = [[0,1,2,3,4], ["a","b","c"], 1] call BIS_fnc_arrayInsert; // returns [0,"a","b","c",1,2,3,4]</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Arrays|{{uc:arrayInsert}}]]
[[Category:Functions|{{uc:arrayInsert}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:arrayInsert}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayInsert}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayInsert}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:arrayInsert}}]]

Latest revision as of 14:52, 13 July 2022

Hover & click on the images for description

Description

Description:
Inserts the elements of one array into another, at a specified index. Neither arrays are touched by reference, a new array is returned.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array1, array2, index] call BIS_fnc_arrayInsert
Parameters:
array1: Array - array to insert into
array2: Array - array to be inserted
index: Number - insertion index
Return Value:
Array - a new array

Examples

Example 1:
private _result = [[0,1,2,3,4], ["a","b","c"], 1] call BIS_fnc_arrayInsert; // returns [0,"a","b","c",1,2,3,4]

Additional Information

See also:
See also needed

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