FirstItem (Arraylist property): Difference between revisions

From m204wiki
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|FirstItem property: Retrieve or set value of first Arraylist item-->
<!--DPL?? Category:Arraylist methods|<var>FirstItem</var> property: Retrieve or set value of first Arraylist item-->
<p>
<p>
FirstItem is a member of the [[Arraylist class]].
<var>FirstItem</var> is a member of the [[Arraylist class]].
</p>
</p>


Line 9: Line 9:
in the method object Arraylist.
in the method object Arraylist.


FirstItem is available in ''Sirius Mods'' version 7.0 and later.
<var>FirstItem</var> is available in ''Sirius Mods'' version 7.0 and later.
==Syntax==
==Syntax==
{{Template:Arraylist:FirstItem syntax}}
{{Template:Arraylist:FirstItem syntax}}
Line 21: Line 21:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The FirstItem method for object %arrayl is equivalent to
<li>The <var>FirstItem</var> method for object %arrayl is equivalent to
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt>.
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](1)</tt>.
<li>[[Dequeue (Arraylist function)|Dequeue]]
<li>[[Dequeue (Arraylist function)|Dequeue]]

Revision as of 23:58, 19 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 %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.
%arrayl An Arraylist object.

Usage notes

  • The FirstItem method for object %arrayl is equivalent to specifying %arrayl:Item(1).
  • Dequeue returns the first item of an Arraylist, then removes the item.
  • LastItem retrieves or sets the last item in an Arraylist.