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|Dequeue function: Retrieve first Arraylist item, then remove item--> | <!--DPL?? Category:Arraylist methods|<var>Dequeue</var> function: Retrieve first Arraylist item, then remove item--> | ||
<p> | <p> | ||
Dequeue is a member of the [[Arraylist class]]. | <var>Dequeue</var> is a member of the [[Arraylist class]]. | ||
</p> | </p> | ||
| Line 9: | Line 9: | ||
in the method object Arraylist; then it removes that item. | in the method object Arraylist; then it removes that item. | ||
Dequeue is available in ''Sirius Mods'' version 7.0 and later. | <var>Dequeue</var> is available in ''Sirius Mods'' version 7.0 and later. | ||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Dequeue syntax}} | {{Template:Arraylist:Dequeue syntax}} | ||
| Line 21: | Line 21: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The Dequeue method for object %arrayl is equivalent to | <li>The <var>Dequeue</var> method for object %arrayl is equivalent to | ||
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt> | specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt> | ||
followed by <tt>%arrayl:[[RemoveItem (Arraylist function)|RemoveItem]](1)</tt>. | followed by <tt>%arrayl:[[RemoveItem (Arraylist function)|RemoveItem]](1)</tt>. | ||
Revision as of 23:58, 19 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 %arrayl declaration to contain the contents of the first %arrayl item. |
|---|---|
| %arrayl | An Arraylist object. |
Usage notes
- The Dequeue method for object %arrayl is equivalent to specifying %arrayl:Item(1) followed by %arrayl: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.