Pop (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
{{Template:Arraylist:Pop subtitle}}
{{Template:Arraylist:Pop subtitle}}
<p>
<var>Pop</var> is a member of the [[Arraylist class]].
</p>


This callable function returns the current contents of the last item
This callable function returns the current contents of the last item

Revision as of 12:12, 27 January 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.

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 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).
  • 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.

See also