Enqueue (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax diagram to template and fix tags) |
||
| Line 3: | Line 3: | ||
This callable function adds an item to the end of an <var>Arraylist</var>. | This callable function adds an item to the end of an <var>Arraylist</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Enqueue syntax}} | {{Template:Arraylist:Enqueue syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>% | <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>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><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> | ||
<tr><th><i> | <tr><th><i>collectionItem</i></th> | ||
<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> | <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== | ||
<ul> | <ul><li>The [[Add (Arraylist function)|Add]] and <var>Enqueue</var> functions are the same. | ||
<li>The [[Add (Arraylist function)|Add]] and <var>Enqueue</var> functions | <li><var>Enqueue</var> was designed as a convenience for use with the <var>[[Dequeue (Arraylist function)|Dequeue]]</var> function. | ||
are the same. | <li><var>Enqueue</var> is available in <var class="product">Sirius Mods</var> version 7.0 and later. | ||
<var>Enqueue</var> was designed as a convenience for use with the | |||
[[Dequeue (Arraylist function)|Dequeue]] function. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Arraylist:Enqueue footer}} | {{Template:Arraylist:Enqueue footer}} | ||
Revision as of 10:21, 29 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 | 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. |
| 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.