Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage Notes) |
mNo edit summary |
||
| Line 6: | Line 6: | ||
</p> | </p> | ||
This 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 Arraylist; then it removes that item. | ||
Revision as of 22:02, 4 January 2011
<section begin=dpl_desc/>Retrieve first Arraylist item, then remove item<section end=dpl_desc/>
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 = %arrayl: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.