Dequeue (Arraylist function)

From m204wiki
Revision as of 02:26, 20 January 2011 by Wiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

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

Dequeue is a member of the Arraylist class.

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

Dequeue is available in Sirius Mods version 7.0 and later.

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