Enqueue (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to template and fix tags)
m (review and edit for better wording)
Line 8: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%count</i></th>
<tr><th><i>%count</i></th>
<td>A numeric variable to contain the number of items in the indicated <var>Arraylist</var> after the item has been added. ''%num'' is also the item number associated with the added item in the <var>Arraylist</var>. </td></tr>
<td>An, optional, numeric variable to contain the number of items in the indicated <var>Arraylist</var> after the item has been added. ''%num'' is also the item number associated with the added item in the <var>Arraylist</var>. </td></tr>
<tr><th><i><var class="term">al</var></i></th>
<tr><th><i><var class="term">al</var></i></th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>

Revision as of 01:41, 31 January 2011

Add item to end of Arraylist (Arraylist class)


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

Syntax

[%count =] al:Enqueue( collectionItem)

Syntax terms

%count An, optional, 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.
al An Arraylist object.
collectionItem A value or variable of the same type as specified on the al 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.
  • Enqueue is available in Sirius Mods version 7.0 and later.

See also