Pop (Arraylist function)

From m204wiki
Revision as of 05:56, 30 January 2011 by Goff (talk | contribs) (match syntax diagram to template and fix tags)
Jump to navigation Jump to search

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.