Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{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|Dequeue function: Retrieve first Arraylist item, then remove item--> | ||
| Line 10: | Line 10: | ||
Dequeue is available in ''Sirius Mods'' version 7.0 and later. | Dequeue is available in ''Sirius Mods'' version 7.0 and later. | ||
==Syntax== | |||
{{Template:Arraylist:Dequeue syntax}} | |||
===Syntax terms=== | |||
<dl> | <dl> | ||
<dt><i>%item</i> | <dt><i>%item</i> | ||
| Line 22: | Line 22: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The Dequeue method for object %arrayl is equivalent to | <li>The Dequeue method for object %arrayl is equivalent to | ||
Revision as of 23:27, 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.