Dequeue (Arraylist function): Difference between revisions

Revision as of 08:09, 2 March 2011

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.

[%item =] al:Dequeue

%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.

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.

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

@@ Line 15: / Line 15: @@
 ==Usage notes==
 <ul><li>The <var>Dequeue</var> method for object <var class="term">al</var> is equivalent to specifying <code><var class="term">al</var>:[[Item (Arraylist property)|Item]](1)</code> followed by <code><var class="term">al</var>:[[RemoveItem (Arraylist function)|RemoveItem]](1)</code>.
-<li>The <var>[[FirstItem (Arraylist property)|FirstItem]]</var> property returns the first item of an <var>Arraylist</var> without removing it.
+<li><var>Dequeue</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.0 and later.
-<li>The [[Pop (Arraylist function)|Pop]] function returns the last item of an <var>Arraylist</var>, then removes it.
-<li><var>Dequeue</var> is available in <var class="product">Sirius Mods</var> version 7.0 and later.
 </ul>
 ==See also==
+<ul><li>The <var>[[FirstItem (Arraylist property)|FirstItem]]</var> property returns the first item of an <var>Arraylist</var> without removing it.
+<li>The [[Pop (Arraylist function)|Pop]] function returns the last item of an <var>Arraylist</var>, then removes it.
+</ul>
 {{Template:Arraylist:Dequeue footer}}