FirstItem (Arraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Arraylist:FirstItem subtitle}} | {{Template:Arraylist:FirstItem subtitle}} | ||
[[Category:Arraylist methods|FirstItem property]] | [[Category:Arraylist methods|FirstItem property]] | ||
<!--DPL?? Category:Arraylist methods|<var>FirstItem</var> property: Retrieve or set value of first Arraylist item--> | <!--DPL?? Category:<var>Arraylist</var> methods|<var>FirstItem</var> property: Retrieve or set value of first <var>Arraylist</var> item--> | ||
<p> | <p> | ||
<var>FirstItem</var> is a member of the [[Arraylist class]]. | <var>FirstItem</var> is a member of the [[Arraylist class]]. | ||
| Line 7: | Line 7: | ||
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 Arraylist. | in the method object <var>Arraylist</var>. | ||
<var>FirstItem</var> is available in ''Sirius Mods'' version 7.0 and later. | <var>FirstItem</var> is available in ''Sirius Mods'' version 7.0 and later. | ||
| Line 15: | Line 15: | ||
<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><var class="term">al</var></i></th> | ||
<td>An Arraylist 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 | <li>The <var>FirstItem</var> method for object <var class="term">al</var> is equivalent to | ||
specifying <tt> | specifying <tt><var class="term">al</var>:[[Item (Arraylist property)|Item]](1)</tt>. | ||
<li>[[Dequeue (Arraylist function)|Dequeue]] | <li>[[Dequeue (Arraylist function)|Dequeue]] | ||
returns the first item of an Arraylist, then removes the item. | returns the first item of an <var>Arraylist</var>, then removes the item. | ||
<li>[[LastItem (Arraylist property)|LastItem]] | <li>[[LastItem (Arraylist property)|LastItem]] | ||
retrieves or sets the last item in an Arraylist. | retrieves or sets the last item in an <var>Arraylist</var>. | ||
</ul> | </ul> | ||
Revision as of 02:29, 20 January 2011
Retrieve or set value of first Arraylist item (Arraylist class)
FirstItem is a member of the Arraylist class.
This readWrite property returns or sets the current contents of the first item in the method object Arraylist.
FirstItem is available in Sirius Mods version 7.0 and later.
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. |