Pop (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (what was I thinking with those blank lines) |
m (→Usage notes) |
||
| (3 intermediate revisions by 3 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. | |||
==Syntax== | ==Syntax== | ||
| Line 16: | Line 16: | ||
<li>The <var>Pop</var> method for object <var class="term">al</var> is equivalent to specifying the following code fragment: | <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>) | <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>: | <var class="term">al</var>:<var>[[RemoveItem (Arraylist function)|RemoveItem]]</var>(<var class="term">al</var>:Count) | ||
</p> | </p> | ||
<li><var>Pop</var> is available in <var class="product">[[Sirius Mods| | <li><var>Pop</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later. | ||
</ul> | </ul> | ||
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.