Pop (Arraylist function)

From m204wiki
Revision as of 23:27, 19 January 2011 by Wiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

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.