Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax diagram to template and fix tags) |
||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Dequeue subtitle}} | {{Template:Arraylist:Dequeue subtitle}} | ||
This callable function returns the current contents of the first item | This callable function returns the current contents of the first item in the method object <var>Arraylist</var>; then it removes that item. | ||
in the method object <var>Arraylist</var>; then it removes that item. | |||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Dequeue syntax}} | {{Template:Arraylist:Dequeue syntax}} | ||
| Line 10: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>%item</i></th> | <tr><th><i>%item</i></th> | ||
<td>A variable of the same type as specified on the | <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><var class="term">al</var></i></th> | <tr><th><i><var class="term">al</var></i></th> | ||
<td>An <var>Arraylist</var> object.</td></tr> | <td>An <var>Arraylist</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <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>Dequeue</var> method for object <var class="term">al</var> 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 < | <li>The [[Pop (Arraylist function)|Pop]] function returns the last item of an <var>Arraylist</var>, then removes it. | ||
followed by < | <li><var>Dequeue</var> is available in ''Sirius Mods'' version 7.0 and later. | ||
<li>The [[FirstItem (Arraylist property)|FirstItem]] property | |||
returns the first item of an <var>Arraylist</var> without removing it. | |||
The [[Pop (Arraylist function)|Pop]] function | |||
returns the last item of an <var>Arraylist</var>, then removes it. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Arraylist:Dequeue footer}} | {{Template:Arraylist:Dequeue footer}} | ||
Revision as of 10:16, 29 January 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.
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 byal: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.