Dequeue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 13: | Line 13: | ||
{{Template:Arraylist:Dequeue syntax}} | {{Template:Arraylist:Dequeue syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th><i>%item</i></th> | ||
< | <td>A variable of the same type as specified on the ''%arrayl'' declaration to contain the contents of the first ''%arrayl'' item. </td></tr> | ||
type as specified on the ''%arrayl'' declaration | <tr><th><i>%arrayl</i></th> | ||
to contain the contents of the first ''%arrayl'' item. | <td>An Arraylist object.</td></tr> | ||
< | </table> | ||
< | |||
</ | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
Revision as of 23:28, 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.