Dequeue (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Arraylist:Dequeue subtitle}}
{{Template:Arraylist:Dequeue subtitle}}
[[Category:Arraylist methods|Dequeue function]]
<var>Dequeue</var> returns the current contents of the first item in the method object <var>Arraylist</var>; then it removes that item.
<!--DPL?? Category:Arraylist methods|<var>Dequeue</var> function: Retrieve first Arraylist item, then remove item-->
<p>
<var>Dequeue</var> is a member of the [[Arraylist class]].
</p>


This callable function returns the current contents of the first item
in the method object Arraylist; then it removes that item.
<var>Dequeue</var> is available in ''Sirius Mods'' version 7.0 and later.
==Syntax==
==Syntax==
{{Template:Arraylist:Dequeue syntax}}
{{Template:Arraylist:Dequeue syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%item</i></th>
<tr><th>%item</th>
<td>A variable of the same type as specified on the ''%arrayl'' declaration to contain the contents of the first ''%arrayl'' item. </td></tr>
<td>A variable of the same type as specified on the <var class="term">al</var> declaration to contain the contents of the first <var class="term">al</var> item. </td></tr>
<tr><th><i>%arrayl</i></th>
<tr><th>al</th>
<td>An Arraylist object.</td></tr>
<td>An <var>Arraylist</var> object.</td></tr>
</table>
</table>
==Usage notes==
==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><var>Dequeue</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later.
</ul>
==See also==
<ul>
<ul>
<li>The <var>Dequeue</var> method for object %arrayl is equivalent to
<li>The <var>[[FirstItem (Arraylist property)|FirstItem]]</var> property returns the first item of an <var>Arraylist</var> without removing it.
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt>
<li>The <var>[[Pop (Arraylist function)|Pop]]</var> function returns the last item of an <var>Arraylist</var>, then removes it.
followed by <tt>%arrayl:[[RemoveItem (Arraylist function)|RemoveItem]](1)</tt>.
<li>The [[FirstItem (Arraylist property)|FirstItem]] property
returns the first item of an Arraylist without removing it.
The [[Pop (Arraylist function)|Pop]] function
returns the last item of an Arraylist, then removes it.
</ul>
</ul>
{{Template:Arraylist:Dequeue footer}}

Latest revision as of 15:31, 1 November 2012

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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Dequeue_(Arraylist_function)&oldid=14239"