FirstItem (Arraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax diagram to template and fix tags) |
||
| Line 1: | Line 1: | ||
{{Template:Arraylist:FirstItem subtitle}} | {{Template:Arraylist:FirstItem subtitle}} | ||
This readWrite property returns or sets the current contents of the first item | This readWrite property returns or sets the current contents of the first item in the method object <var>Arraylist</var>. | ||
in the method object <var>Arraylist</var>. | |||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:FirstItem syntax}} | {{Template:Arraylist:FirstItem syntax}} | ||
| Line 10: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>%item</i></th> | <tr><th><i>%item</i></th> | ||
<td>A variable of the same type as specified on the | <td>A variable of the same type as specified on the <var class="term">al</var> declaration to contain the contents of the first <var class="term">al</var> item. Or a variable or value of the same type as specified on the <var class="term">al</var> declaration to be assigned to the first <var class="term">al</var> item. </td></tr> | ||
<tr><th><i | <tr><th><i>al</i></th> | ||
<td>An <var>Arraylist</var> object.</td></tr> | <td>An <var>Arraylist</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul><li>The <var>FirstItem</var> method for object <var class="term">al</var> is equivalent to specifying <code><var class="term">al</var>:[[Item (Arraylist property)|Item]](1)</code>. | ||
<li>The <var>FirstItem</var> method for object <var class="term">al</var> is equivalent to | <li>[[Dequeue (Arraylist function)|Dequeue]] returns the first item of an <var>Arraylist</var>, then removes the item. | ||
specifying < | <li>[[LastItem (Arraylist property)|LastItem]] retrieves or sets the last item in an <var>Arraylist</var>. | ||
<li>[[Dequeue (Arraylist function)|Dequeue]] | <li><var>FirstItem</var> is available in <var class="product">Sirius Mods</var>'' version 7.0 and later. | ||
returns the first item of an <var>Arraylist</var>, then removes the item. | |||
<li>[[LastItem (Arraylist property)|LastItem]] | |||
retrieves or sets the last item in an <var>Arraylist</var>. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Arraylist:FirstItem footer}} | {{Template:Arraylist:FirstItem footer}} | ||
Revision as of 04:43, 30 January 2011
Retrieve or set value of first Arraylist item (Arraylist class)
This readWrite property returns or sets the current contents of the first item in the method object Arraylist.
Syntax
%currentItem = al:FirstItem al:FirstItem = newItem
Syntax terms
| %item | A variable of the same type as specified on the al declaration to contain the contents of the first al item. Or a variable or value of the same type as specified on the al declaration to be assigned to the first al item. |
|---|---|
| al | An Arraylist object. |
Usage notes
- The FirstItem method for object al is equivalent to specifying
al:Item(1). - Dequeue returns the first item of an Arraylist, then removes the item.
- LastItem retrieves or sets the last item in an Arraylist.
- FirstItem is available in Sirius Mods version 7.0 and later.