Push (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to template and fix tags)
mNo edit summary
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Arraylist:Push subtitle}}
{{Template:Arraylist:Push subtitle}}
 
This [[Notation conventions for methods#Callable functions|callable]] function adds an item to the end of an <var>Arraylist</var>.
This callable function adds an item to the end of an <var>Arraylist</var>.


==Syntax==
==Syntax==
Line 9: Line 8:
<tr><th>%count</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><var class="term">al</var></th>
<tr><th>al</th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th>collectionItem</th>
<tr><th>collectionItem</th>
Line 18: Line 17:
<ul>
<ul>
<li><var>Push</var> was designed as a convenience for use with the <var>[[Pop (Arraylist function)|Pop]]</var> function.
<li><var>Push</var> was designed as a convenience for use with the <var>[[Pop (Arraylist function)|Pop]]</var> function.
<li><var>Push</var> is available in <var class="product">Sirius Mods</var> version 7.0 and later.
<li><var>Push</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later.
</ul>
</ul>



Latest revision as of 21:00, 18 July 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.