Push (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Arraylist:Push subtitle}}
{{Template:Arraylist:Push subtitle}}
[[Category:Arraylist methods|Push function]]
This [[Notation conventions for methods#Callable functions|callable]] function adds an item to the end of an <var>Arraylist</var>.
<!--DPL?? Category:Arraylist methods|<var>Push</var> function: Append item to Arraylist-->
<p>
<var>Push</var> is a member of the [[Arraylist class]].
</p>


This callable function adds an item to the end of an Arraylist.
<var>Push</var> is available in ''Sirius Mods'' version 7.0 and later.
==Syntax==
==Syntax==
{{Template:Arraylist:Push syntax}}
{{Template:Arraylist:Push syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%num</i></th>
<tr><th>%count</th>
<td>A numeric variable to contain the number of items in the indicated Arraylist after the item has been added. ''%num'' is also the item number associated with the added item in the Arraylist. </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>%arrayl</i></th>
<tr><th>al</th>
<td>An Arraylist object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>item</i></th>
<tr><th>collectionItem</th>
<td>A value or variable of the same type as specified on the ''%arrayl'' declaration, or a value or variable convertible to that type.</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>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The [[Add (Arraylist function)|Add]] and <var>Push</var> functions
<li><var>Push</var> was designed as a convenience for use with the <var>[[Pop (Arraylist function)|Pop]]</var> function.
are the same.
<li><var>Push</var> is available in <var class="product">[[Sirius Mods|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==
<ul><li>The <var>[[Add (Arraylist function)|Add]]</var> and <var>Push</var> functions are the same.</ul>
{{Template:Arraylist:Push footer}}

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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Push_(Arraylist_function)&oldid=14811"