FirstItem (Arraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Retrieve or set value of first Arraylist item<section end=dpl_desc/></b></span>
{{Template:Arraylist:FirstItem subtitle}}
[[Category:Arraylist methods|FirstItem property]]
The <var>FirstItem</var> readWrite property returns or sets the current contents of the first item in the method object <var>Arraylist</var>.
<!--DPL?? Category:Arraylist methods|FirstItem property: Retrieve or set value of first Arraylist item-->
<p>
FirstItem is a member of the [[Arraylist class]].
</p>


This readWrite property returns or sets the current contents of the first item
==Syntax==
in the method object Arraylist.
{{Template:Arraylist:FirstItem syntax}}
===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>
<tr><th>al</th>
<td>An <var>Arraylist</var> object.</td></tr>
<tr><th>newItem</th>
<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>
</table>


FirstItem is available in ''Sirius Mods'' version 7.0 and later.
==Usage notes==
===Syntax===
<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>.
  %item = %arrayl:FirstItem
<li><var>FirstItem</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later.
</ul>


  %arrayl:FirstItem = %item
==See also==
====Syntax Terms====
<ul><li><var>[[Dequeue (Arraylist function)|Dequeue]]</var> returns the first item of an <var>Arraylist</var>, then removes the item.
<dl>
<li><var>[[LastItem (Arraylist property)|LastItem]]</var> retrieves or sets the last item in an <var>Arraylist</var>.</ul>
<dt><i>%item</i>
{{Template:Arraylist:FirstItem footer}}
<dd>A variable of the same
type as specified on the ''%arrayl'' declaration
to contain the contents of the first ''%arrayl'' item.
Or a variable or value of the same
type as specified on the ''%arrayl'' declaration
to be assigned to the first ''%arrayl'' item.
<dt><i>%arrayl</i>
<dd>An Arraylist object.
 
</dl>
===Usage Notes===
<ul>
<li>The FirstItem method for object %arrayl is equivalent to
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt>.
<li>[[Dequeue (Arraylist function)|Dequeue]]
returns the first item of an Arraylist, then removes the item.
<li>[[LastItem (Arraylist property)|LastItem]]
retrieves or sets the last item in an Arraylist.
</ul>

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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=FirstItem_(Arraylist_property)&oldid=14450"