Pop (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
| (14 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Pop subtitle}} | {{Template:Arraylist:Pop subtitle}} | ||
[[ | This [[Notation conventions for methods#Callable functions|callable]] function returns the current contents of the last item in the method object <var>Arraylist</var>; then it removes that item. | ||
in the method object <var>Arraylist</var>; then it removes that item. | |||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Pop syntax}} | {{Template:Arraylist:Pop syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%item</th> | ||
<td> | <td>An, optional, variable of the same type as specified on the <var class="term">al</var> declaration to contain the contents of the last <var class="term">al</var> item. </td></tr> | ||
<tr><th | <tr><th>al</th> | ||
<td>An <var>Arraylist</var> object.</td></tr> | <td>An <var>Arraylist</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The <var>Pop</var> method for object <var class="term">al</var> is equivalent to | <li>The <var>Pop</var> method for object <var class="term">al</var> is equivalent to specifying the following code fragment: | ||
<p class="code"><var class="term">al</var>:<var>[[Item (Arraylist property)|Item]]</var>(<var class="term">al</var>:<var>[[Count (Arraylist property)|Count]]</var>) | |||
<var class="term">al</var>:<var>[[RemoveItem (Arraylist function)|RemoveItem]]</var>(<var class="term">al</var>:Count) | |||
<li>[[LastItem (Arraylist property)|LastItem]] | </p> | ||
returns the last item of an <var>Arraylist</var> without removing it. | |||
[[Dequeue (Arraylist function)|Dequeue]] | <li><var>Pop</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later. | ||
returns the first item of an <var>Arraylist</var>, then removes it. | </ul> | ||
<li> | |||
appends an item to an <var>Arraylist</var>. | ==See also== | ||
<ul> | |||
<li><var>[[LastItem (Arraylist property)|LastItem]]</var> returns the last item of an <var>Arraylist</var> without removing it. | |||
<li><var>[[Dequeue (Arraylist function)|Dequeue]]</var> returns the first item of an <var>Arraylist</var>, then removes it. | |||
<li><var>[[Push (Arraylist function)|Push]]</var>, a synonym for Add, appends an item to an <var>Arraylist</var>. | |||
</ul> | </ul> | ||
{{Template:Arraylist:Pop footer}} | |||
Latest revision as of 16:17, 1 November 2012
Retrieve last Arraylist item, then remove item (Arraylist class)
This callable function returns the current contents of the last item in the method object Arraylist; then it removes that item.
Syntax
[%item =] al:Pop
Syntax terms
| %item | An, optional, variable of the same type as specified on the al declaration to contain the contents of the last al item. |
|---|---|
| al | An Arraylist object. |
Usage notes
- The Pop method for object al is equivalent to specifying the following code fragment:
al:Item(al:Count) al:RemoveItem(al:Count)
- Pop is available in Sirius Mods Version 7.0 and later.
See also
- LastItem returns the last item of an Arraylist without removing it.
- Dequeue returns the first item of an Arraylist, then removes it.
- Push, a synonym for Add, appends an item to an Arraylist.