Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage Notes) |
||
| Line 25: | Line 25: | ||
<ul> | <ul> | ||
<li>The Dequeue method for object %arrayl is equivalent to | <li>The Dequeue 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>. | |||
<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 Arraylist without removing it. | ||
Revision as of 21:52, 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 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.