Push (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Push subtitle}} | {{Template:Arraylist:Push subtitle}} | ||
[[Category:Arraylist methods|Push function]] | [[Category:Arraylist methods|Push function]] | ||
<!--DPL?? Category:Arraylist methods|Push function: Append item to Arraylist--> | <!--DPL?? Category:Arraylist methods|<var>Push</var> function: Append item to Arraylist--> | ||
<p> | <p> | ||
Push is a member of the [[Arraylist class]]. | <var>Push</var> is a member of the [[Arraylist class]]. | ||
</p> | </p> | ||
This callable function adds an item to the end of an Arraylist. | This callable function adds an item to the end of an Arraylist. | ||
Push is available in ''Sirius Mods'' version 7.0 and later. | <var>Push</var> is available in ''Sirius Mods'' version 7.0 and later. | ||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Push syntax}} | {{Template:Arraylist:Push syntax}} | ||
| Line 22: | Line 22: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The [[Add (Arraylist function)|Add]] and Push functions | <li>The [[Add (Arraylist function)|Add]] and <var>Push</var> functions | ||
are the same. | are the same. | ||
Push was designed as a convenience for use with the | <var>Push</var> was designed as a convenience for use with the | ||
[[Pop (Arraylist function)|Pop]] function. | [[Pop (Arraylist function)|Pop]] function. | ||
</ul> | </ul> | ||
Revision as of 23:58, 19 January 2011
Append item to Arraylist (Arraylist class)
Push is a member of the Arraylist class.
This callable function adds an item to the end of an Arraylist.
Push is available in Sirius Mods version 7.0 and later.
Syntax
[%count =] al:Push( collectionItem)
Syntax terms
| %num | 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. |
|---|---|
| %arrayl | An Arraylist object. |
| item | A value or variable of the same type as specified on the %arrayl declaration, or a value or variable convertible to that type. |