Pop (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to template and fix tags)
m (match syntax diagram to template and fix tags)
Line 7: Line 7:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%item</i></th>
<tr><th>%item</th>
<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>
<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><i><var class="term">al</var></i></th>
<tr><th><var class="term">al</var></th>
<td>An <var>Arraylist</var> object.</td></tr>
<td>An <var>Arraylist</var> object.</td></tr>
</table>
</table>

Revision as of 01:47, 2 February 2011

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 al:Item(al:Count) followed by 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.