Item (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Template:Stringlist:Item subtitle}}
{{Template:Stringlist:Item subtitle}}
This method returns the current contents of a specified <var>Stringlist</var> item.
The <var>Item</var> method accepts one argument and returns a string result.


==Syntax==
==Syntax==
{{Template:Stringlist:Item syntax}}
{{Template:Stringlist:Item syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 20: Line 17:
<ul>
<ul>
<li>All errors in <var>Item</var> result in request cancellation.
<li>All errors in <var>Item</var> result in request cancellation.
<li>Unlike the <var>[[Item (Arraylist property)|Item]]</var> method for <var>[[Collections]]</var>, the <var>Item</var> method for <var>stringlists</var> is not settable. To set a new value for a <var>stringlist</var> item, use [[Replace (Stringlist function)|Replace]].</ul>
<li>Unlike the <var>[[Item (Arraylist property)|Item]]</var> method for <var>[[Collections]]</var>, the <var>Item</var> method for <var>stringlists</var> is not settable. To set a new value for a <var>stringlist</var> item, use <var>[[Replace (Stringlist function)|Replace]]</var>.</ul>


==Examples==
==Examples==

Latest revision as of 17:43, 1 June 2012

Retrieve value of Stringlist item (Stringlist class)


Syntax

%string = sl:Item( itemNum)

Syntax terms

%string This longstring is to contain the contents of the sl item.
sl A Stringlist object.
itemNum The number of the item in the sl Stringlist.

Usage notes

  • All errors in Item result in request cancellation.
  • Unlike the Item method for Collections, the Item method for stringlists is not settable. To set a new value for a stringlist item, use Replace.

Examples

  1. The following loop uses the Item method to display the contents of a Stringlist:

    for %i from 1 to %list:count print %list:item(%i) end for

    This could be accomplished much more easily with:

    %list:print

  2. Under Sirius Mods Version 6.8 and later, the method name, Item, is not necessary on a Stringlist Item reference. For example, the previous program with Item references could be written as:

    for %i from 1 to %list:count print %list(%i) end for

See also

There are optimized methods available to retrieve just the first or just the last item in a Stringlist: