Push (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to template and fix tags)
m (match syntax diagram to template and fix tags)
Line 7: Line 7:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%count</i></th>
<tr><th>%count</th>
<td>An, optional, numeric variable to return the number of items in the indicated <var>Arraylist</var> after the item has been added. <var class="term">%count</var> is also the item number associated with the added item in the <var>Arraylist</var>. </td></tr>
<td>An, optional, numeric variable to return the number of items in the indicated <var>Arraylist</var> after the item has been added. <var class="term">%count</var> is also the item number associated with the added item in the <var>Arraylist</var>. </td></tr>
<tr><th><i><var class="term">al</var></i></th>
<tr><th><var class="term">al</var></th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>collectionItem</i></th>
<tr><th>collectionItem</th>
<td>A value or variable of the same type as specified on the <var class="term">al</var> declaration, or a value or variable convertible to that type, that will be appended to the end of <var class="term">al</var> .</td></tr>
<td>A value or variable of the same type as specified on the <var class="term">al</var> declaration, or a value or variable convertible to that type, that will be appended to the end of <var class="term">al</var> .</td></tr>
</table>
</table>

Revision as of 01:47, 2 February 2011

Append item to Arraylist (Arraylist class)


This callable function adds an item to the end of an Arraylist.

Syntax

[%count =] al:Push( collectionItem)

Syntax terms

%count An, optional, numeric variable to return the number of items in the indicated Arraylist after the item has been added. %count is also the item number associated with the added item in the Arraylist.
al An Arraylist object.
collectionItem A value or variable of the same type as specified on the al declaration, or a value or variable convertible to that type, that will be appended to the end of al .

Usage notes

  • Push was designed as a convenience for use with the Pop function.
  • Push is available in Sirius Mods version 7.0 and later.

See also

  • The Add and Push functions are the same.