Insert (Arraylist function)
Insert items into Arraylist (Arraylist class)
The Insert callable function inserts a new item before the number item in the Arraylist.
Syntax
[%count =] al:Insert( number, itemList)
Syntax terms
| %count | An, optional, numeric variable to return the number of items in the indicated Arraylist after the items have been inserted. |
|---|---|
| al | An Arraylist object. |
| number | A whole number, from 1 to the number of items in al plus one, to identify an al item before which the items in itemList will be inserted. |
| itemList | Under Sirius Mods 7.9 and later this can be a comma-delimited set of values or variables of the same type as specified on the al declaration or collections of objects of the same type as specified on the al declaration. Each of these, from left to right, is inserted into the method object Arraylist.
Under Sirius Mods 7.8 and earlier itemList can only be a single value or variable of the same type as specified on the al declaration, or a value or variable convertible to that type to be inserted into the method object Arraylist. Of course, a single value or variable is just a single item list so can be specified under Sirius Mods 7.9 and later, too. |
Usage notes
- If number is less than or equal to the number of items in the Arraylist, the new item is inserted before the indicated item.
- If number is equal to the number of items in the Arraylist plus one, the new item is added to the end of the Arraylist.
- If number is greater than the number of items in the Arraylist plus one, or less than or equal to zero, the request is cancelled.
Examples
- For an example using the Insert method, see "Arraylist class".