Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax diagram to template and fix tags) |
m (→See also) |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Dequeue subtitle}} | {{Template:Arraylist:Dequeue subtitle}} | ||
<var>Dequeue</var> returns the current contents of the first item in the method object <var>Arraylist</var>; then it removes that item. | |||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%item</th> | ||
<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> | <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 | <tr><th>al</th> | ||
<td>An <var>Arraylist</var> object.</td></tr> | <td>An <var>Arraylist</var> object.</td></tr> | ||
</table> | </table> | ||
| Line 15: | Line 14: | ||
==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>. | <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> | <li><var>Dequeue</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later. | ||
</ul> | </ul> | ||
==See also== | ==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 <var>[[Pop (Arraylist function)|Pop]]</var> function returns the last item of an <var>Arraylist</var>, then removes it. | |||
</ul> | |||
{{Template:Arraylist:Dequeue footer}} | {{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 byal: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.