FirstItem (GenericNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 16: Line 16:
<ul>
<ul>
<li><var>FirstItem</var> is the same as the <var>[[ItemByNumber (GenericNamedArraylist property)|ItemByNumber]]</var> property with a <var class="syntax">number</var> argument of 1.
<li><var>FirstItem</var> is the same as the <var>[[ItemByNumber (GenericNamedArraylist property)|ItemByNumber]]</var> property with a <var class="syntax">number</var> argument of 1.
<li>The request is cancelled if the <var class="syntax">anyNal</var> collection is empty.
<li>The request is cancelled if the <var class="term">anyNal</var> collection is empty.
</ul>
</ul>



Revision as of 21:58, 26 February 2013

Return or set first item (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)

[Introduced in Sirius Mods 8.1]


Syntax

%currentItem = anyNal:FirstItem anyNal:FirstItem = newItem

Syntax terms

%currentItem A variable of the same type as specified on the anyNal declaration to contain the value of the specified anyNal item.
anyNal A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object.
newItem A value of the same type as specified on the anyNal declaration to be assigned to the specified anyNal item.

Usage notes

  • FirstItem is the same as the ItemByNumber property with a number argument of 1.
  • The request is cancelled if the anyNal collection is empty.

Examples

See also

The LastItem property is the last item in the collection.