insert

2.02

Hover & click on the images for description

Description

Description:

Inserts multiple values into Array/String/HashMap.
The String variant also supports forceUnicode.

Groups:

HashMapArraysStrings

Syntax 1

Syntax:

array insert [index, valuesToInsert, onlyIfUnique]

Parameters:

array : Array

index: Number - index at which the values will be inserted, -1 for append.

valuesToInsert: Array of Anything - values to insert at the specified index

onlyIfUnique: Boolean - only insert if the value is unique in the array, like pushBackUnique

Return Value:

Nothing

Syntax 2

Syntax:

string insert [index, substring]

Parameters:

string : String

index: Number - index at which the values will be inserted, -1 for append.

substring: String - string to insert

Return Value:

String - the new string

2.04

Syntax 3

Syntax:

hashMap insert [[key1, value1], [key2, value2], ...]

Parameters:

hashMap: HashMap

key: HashMapKey

value: Anything

Return Value:

Nothing

2.04

Syntax 4

Syntax:

hashMap insert [splitArray, [keysAndValues]]

Parameters:

hashMap: HashMap

splitArray: Boolean - determines keysAndValues format (see keysAndValues's description)

keysAndValues: Array - in format depending on splitArray's value:

• true - [[key1, key2, ...], [value1, value2, ...]]
• false - [[key1, value1], [key2, value2], ...] (same as Syntax 3)

Return Value:

Nothing

Examples

Example 1:

"Test" insert [0, "Radio"]; // returns "RadioTest"

Additional Information

See also:

HashMap pushBack pushBackUnique append + merge

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