Dequeue (Arraylist function)

From m204wiki
Revision as of 17:45, 4 May 2011 by Goff (talk | contribs) (what's in a name)
Jump to navigation Jump to search

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

Dequeue returns the current contents of the first item in the method object Arraylist; then it removes that item.

Syntax

[%item =] al:Dequeue

Syntax terms

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

Usage notes

  • The Dequeue method for object al is equivalent to specifying al:Item(1) followed by al:RemoveItem(1).
  • Dequeue is available in Sirius Mods Version 7.0 and later.

See also

  • The FirstItem property returns the first item of an Arraylist without removing it.
  • The Pop function returns the last item of an Arraylist, then removes it.