Push (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax diagram to template and fix tags) |
||
| Line 3: | Line 3: | ||
This 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== | ||
{{Template:Arraylist:Push syntax}} | {{Template:Arraylist:Push syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>% | <tr><th><i>%count</i></th> | ||
<td> | <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><i><var class="term">al</var></i></th> | ||
<td>An <var>Arraylist</var> object. </td></tr> | <td>An <var>Arraylist</var> object. </td></tr> | ||
<tr><th><i> | <tr><th><i>collectionItem</i></th> | ||
<td>A value or variable of the same type as specified on the | <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> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li> | <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. | |||
<var>Push</var> was designed as a convenience for use with the | |||
[[Pop (Arraylist function)|Pop]] function. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
<ul><li>The <var>[[Add (Arraylist function)|Add]]</var> and <var>Push</var> functions are the same.</ul> | |||
{{Template:Arraylist:Push footer}} | {{Template:Arraylist:Push footer}} | ||
Revision as of 06:47, 30 January 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.