Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Dequeue subtitle}} | {{Template:Arraylist:Dequeue subtitle}} | ||
[[Category:Arraylist methods|Dequeue function]] | [[Category:Arraylist methods|Dequeue function]] | ||
<!--DPL?? Category:Arraylist methods|<var>Dequeue</var> function: Retrieve first Arraylist item, then remove item--> | <!--DPL?? Category:<var>Arraylist</var> methods|<var>Dequeue</var> function: Retrieve first <var>Arraylist</var> item, then remove item--> | ||
<p> | <p> | ||
<var>Dequeue</var> is a member of the [[Arraylist class]]. | <var>Dequeue</var> is a member of the [[Arraylist class]]. | ||
| Line 7: | Line 7: | ||
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 Arraylist; then it removes that item. | in the method object <var>Arraylist</var>; then it removes that item. | ||
<var>Dequeue</var> is available in ''Sirius Mods'' version 7.0 and later. | <var>Dequeue</var> is available in ''Sirius Mods'' version 7.0 and later. | ||
| Line 17: | Line 17: | ||
<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><i><var class="term">al</var></i></th> | <tr><th><i><var class="term">al</var></i></th> | ||
<td>An Arraylist object.</td></tr> | <td>An <var>Arraylist</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
| Line 25: | Line 25: | ||
followed by <tt><var class="term">al</var>:[[RemoveItem (Arraylist function)|RemoveItem]](1)</tt>. | followed by <tt><var class="term">al</var>:[[RemoveItem (Arraylist function)|RemoveItem]](1)</tt>. | ||
<li>The [[FirstItem (Arraylist property)|FirstItem]] property | <li>The [[FirstItem (Arraylist property)|FirstItem]] property | ||
returns the first item of an Arraylist without removing it. | returns the first item of an <var>Arraylist</var> without removing it. | ||
The [[Pop (Arraylist function)|Pop]] function | The [[Pop (Arraylist function)|Pop]] function | ||
returns the last item of an Arraylist, then removes it. | returns the last item of an <var>Arraylist</var>, then removes it. | ||
</ul> | </ul> | ||
Revision as of 02:27, 20 January 2011
Retrieve first Arraylist item, then remove item (Arraylist class)
Dequeue is a member of the Arraylist class.
This callable function returns the current contents of the first item in the method object Arraylist; then it removes that item.
Dequeue is available in Sirius Mods version 7.0 and later.
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.