Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 15: | Line 15: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>%item</i></th> | <tr><th><i>%item</i></th> | ||
<td>A variable of the same type as specified on the '' | <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> | <tr><th><i><var class="term">al</var></i></th> | ||
<td>An Arraylist object.</td></tr> | <td>An Arraylist object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The <var>Dequeue</var> method for object | <li>The <var>Dequeue</var> method for object <var class="term">al</var> is equivalent to | ||
specifying <tt> | specifying <tt><var class="term">al</var>:[[Item (Arraylist property)|Item]](1)</tt> | ||
followed by <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 Arraylist without removing it. | ||
Revision as of 02:26, 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.