Dequeue (Arraylist function)

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

This callable function 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).
• 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.
• Dequeue is available in Sirius Mods version 7.0 and later.

See also

Arraylist class FloatNamedArraylist class NamedArraylist class UnicodeNamedArraylist class	List of Arraylist methods List of FloatNamedArraylist methods List of NamedArraylist methods List of UnicodeNamedArraylist methods List of Collection methods	Arraylist methods syntax FloatNamedArraylist methods syntax NamedArraylist methods syntax UnicodeNamedArraylist methods syntax
Notation conventions for methods