Dequeue (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
{{Template:Arraylist:Dequeue subtitle}}
{{Template:Arraylist:Dequeue subtitle}}
<p>
<var>Dequeue</var> is a member of the [[Arraylist class]].
</p>


This callable function returns the current contents of the first item
This callable function returns the current contents of the first item

Revision as of 12:12, 27 January 2011

Retrieve first Arraylist item, then remove item (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.

See also