Pop (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 13: Line 13:
{{Template:Arraylist:Pop syntax}}
{{Template:Arraylist:Pop syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%item</i>
<tr><th><i>%item</i></th>
<dd>A variable of the same
<td>A variable of the same type as specified on the ''%arrayl'' declaration to contain the contents of the last ''%arrayl'' item. </td></tr>
type as specified on the ''%arrayl'' declaration
<tr><th><i>%arrayl</i></th>
to contain the contents of the last ''%arrayl'' item.
<td>An Arraylist object.</td></tr>
<dt><i>%arrayl</i>
</table>
<dd>An Arraylist object.
 
</dl>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 23:28, 19 January 2011

Retrieve last Arraylist item, then remove item (Arraylist class)

Pop is a member of the Arraylist class.

This callable function returns the current contents of the last item in the method object Arraylist; then it removes that item.

Pop is available in Sirius Mods version 7.0 and later.

Syntax

[%item =] al:Pop

Syntax terms

%item A variable of the same type as specified on the %arrayl declaration to contain the contents of the last %arrayl item.
%arrayl An Arraylist object.

Usage notes

  • The Pop method for object %arrayl is equivalent to specifying %arrayl:Item(%arrayl:Count) followed by %arrayl:RemoveItem(%arrayl:Count).
  • LastItem returns the last item of an Arraylist without removing it. Dequeue returns the first item of an Arraylist, then removes it.
  • The Push function, a synonym for Add, appends an item to an Arraylist.