Word (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 37: Line 37:
<ul>
<ul>
<li>[[List of StringTokenizer methods]]
<li>[[List of StringTokenizer methods]]
<li>[[Words (String function)|Words]] - Sublist of list of words
<li><var>[[Words (String function)|Words]]</var> - Sublist of list of words
<li>[[WordCount (String function)|WordCount]] - Count words in list
<li><var>[[WordCount (String function)|WordCount]]</var> - Count words in list
<li>[[WordNumberIn and WordNumberOf (String functions)|WordNumberIn and WordNumberOf]] - Word number of "needle" word within "haystack" list of words
<li><var>[[WordNumberIn and WordNumberOf (String functions)|WordNumberIn and WordNumberOf]]</var> - Word number of "needle" word within "haystack" list of words
<li><var>Word</var> is the OO version of <var>$Lstr_Word</var>, although there
is one difference: <var>$Lstr_Word</var> allows a word number argument which is
less than 1 (and treats it the same as if 1 were specified).
As mentioned above, <var>Word</var> does not allow a word number argument which
is less than 1.
</ul>
</ul>
{{Template:String:Word footer}}
{{Template:String:Word footer}}

Revision as of 14:45, 21 March 2012

Select word from list of words (String class)

[Introduced in Sirius Mods 7.9]


Note that processing a string of words may be better accomplished with the StringTokenizer class.

Syntax

%selectedWord = string:Word( number, [Spaces= string])

Syntax terms

%selectedWordWord returns the word selected by number within the string method object.
string The list of words, from which the result word is selected.
number The number of the word to select from the string method object. The first word is word number 1. The value of this argument must be greater than or equal to 1. If number is greater than the number of words in string, the null string is returned.
Spaces A set of "whitespace" characters, that is, characters that separate words. The default is the blank character. If the null string is provided, the blank character is used as the whitespace character.

Usage notes

Examples

The following fragment:

PrintText {~='Dasher**** Dancer**** Prancer****':Word(2)}. PrintText {~='Dasher**** Dancer**** Prancer****':Word(2, Spaces=' *)')}. PrintText {~='One more time':Word(4))}.

produces the following result:

'Dasher**** Dancer**** Prancer****':Word(2)=Dancer****. 'Dasher**** Dancer**** Prancer****':Word(2, Spaces=' *)')=Dancer. 'One more time':Word(4))=.

See also