Enqueue (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:Enqueue subtitle}}
{{Template:Arraylist:Enqueue subtitle}}
[[Category:Arraylist methods|Enqueue function]]
[[Category:Arraylist methods|Enqueue function]]
<!--DPL?? Category:Arraylist methods|<var>Enqueue</var> function: Add item to end of Arraylist-->
<!--DPL?? Category:<var>Arraylist</var> methods|<var>Enqueue</var> function: Add item to end of <var>Arraylist</var>-->
<p>
<p>
<var>Enqueue</var> is a member of the [[Arraylist class]].
<var>Enqueue</var> is a member of the [[Arraylist class]].
</p>
</p>


This callable function adds an item to the end of an Arraylist.
This callable function adds an item to the end of an <var>Arraylist</var>.


<var>Enqueue</var> is available in ''Sirius Mods'' version 7.0 and later.
<var>Enqueue</var> is available in ''Sirius Mods'' version 7.0 and later.
Line 14: Line 14:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%num</i></th>
<tr><th><i>%num</i></th>
<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>
<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>
<tr><th><i>%arrayl</i></th>
<tr><th><i><var class="term">al</var></i></th>
<td>An Arraylist object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>item</i></th>
<tr><th><i>item</i></th>
<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>
<td>A value or variable of the same type as specified on the ''<var class="term">al</var>'' declaration, or a value or variable convertible to that type.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==

Revision as of 02:29, 20 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.
al An Arraylist object.
item 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.