Enqueue (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 12: Line 12:
{{Template:Arraylist:Enqueue syntax}}
{{Template:Arraylist:Enqueue syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%num</i>
<tr><th><i>%num</i></th>
<dd>A numeric variable to contain the number of
<td>A numeric variable to contain the number of items in the indicated Arraylist after the item has been added. ''%num'' is also the item number associated with the added item in the Arraylist. </td></tr>
items in the indicated Arraylist after the item has been added.
<tr><th><i>%arrayl</i></th>
''%num'' is also the item number associated with the
<td>An Arraylist object. </td></tr>
added item in the Arraylist.
<tr><th><i>item</i></th>
<dt><i>%arrayl</i>
<td>A value or variable of the same type as specified on the ''%arrayl'' declaration, or a value or variable convertible to that type.</td></tr>
<dd>An Arraylist object.
</table>
<dt><i>item</i>
<dd>A value or variable of the same
type as specified on the ''%arrayl'' declaration, or a value or variable
convertible to that type.
 
</dl>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 23:28, 19 January 2011

Add item to end of Arraylist (Arraylist class)

Enqueue is a member of the Arraylist class.

This callable function adds an item to the end of an Arraylist.

Enqueue is available in Sirius Mods version 7.0 and later.

Syntax

[%count =] al:Enqueue( collectionItem)

Syntax terms

%num A numeric variable to contain the number of items in the indicated Arraylist after the item has been added. %num is also the item number associated with the added item in the Arraylist.
%arrayl An Arraylist object.
item A value or variable of the same type as specified on the %arrayl declaration, or a value or variable convertible to that type.

Usage notes

  • The Add and Enqueue functions are the same. Enqueue was designed as a convenience for use with the Dequeue function.