FirstItem (Arraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| (19 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Arraylist:FirstItem subtitle}} | {{Template:Arraylist:FirstItem subtitle}} | ||
The <var>FirstItem</var> readWrite property returns or sets the current contents of the first item in the method object <var>Arraylist</var>. | |||
< | |||
< | |||
</ | |||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:FirstItem syntax}} | {{Template:Arraylist:FirstItem syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%currentItem</th> | ||
< | <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.</td></tr> | ||
type as specified on the | <tr><th>al</th> | ||
to contain the contents of the first | <td>An <var>Arraylist</var> object.</td></tr> | ||
<tr><th>newItem</th> | |||
type as specified on the | <td>A 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> | ||
to be assigned to the first | </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 FirstItem method for object | <li><var>FirstItem</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later. | ||
specifying < | |||
<li>[[ | |||
< | |||
</ul> | </ul> | ||
==See also== | |||
<ul><li><var>[[Dequeue (Arraylist function)|Dequeue]]</var> returns the first item of an <var>Arraylist</var>, then removes the item. | |||
<li><var>[[LastItem (Arraylist property)|LastItem]]</var> retrieves or sets the last item in an <var>Arraylist</var>.</ul> | |||
{{Template:Arraylist:FirstItem footer}} | |||
Latest revision as of 17:45, 4 May 2011
Retrieve or set value of first Arraylist item (Arraylist class)
The FirstItem 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
| %currentItem | A variable of the same type as specified on the al declaration to contain the contents of the first al item. |
|---|---|
| al | An Arraylist object. |
| newItem | A value of the same type as specified on the al declaration to be assigned to the first al item. |
Usage notes
- The FirstItem method for object al is equivalent to specifying
al:Item(1). - FirstItem is available in Sirius Mods Version 7.0 and later.
See also
- Dequeue returns the first item of an Arraylist, then removes the item.
- LastItem retrieves or sets the last item in an Arraylist.