WordNumberIn and WordNumberOf (String functions)

From m204wiki
Jump to navigation Jump to search

The word number of a word within a list of words (String class)

[Introduced in Sirius Mods 7.9]

The WordNumberIn and WordNumberOf functions return the word number of the first occurrence of one word (the "needle") within a list of words ("the haystack"). The search respects character case.

The only difference between the two methods is that for WordNumberIn, the method object string is the "needle" and the first argument is the "haystack", whereas for WordNumberOf, the first argument is the "needle" and the method object string is the "haystack". Which method is more convenient to use will be application dependent.

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


%number = string:WordNumberIn( haystack, [Spaces= string])

%number = string:WordNumberOf( needle, [Spaces= string])

Syntax terms

%number A variable to receive the number of the first occurrence of the "needle" word in the "haystack" list of words. If the word "needle" is not one of the words in "haystack", %number is set to 0.
string The method object string; either:
  • the search target "needle," when called as WordNumberIn
  • the list of words "haystack," when called as WordNumberOf
haystack In WordNumberIn, the list of words within which the string method object (the "needle") is searched for.
needle In WordNumberOf, the word to be searched for within the string method object list of words (the "haystack").
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


  1. The following fragment:

    PrintText {~='aa bb cc':WordNumberOf('bb')} PrintText {~='bb':WordNumberIn('aa bb cc')}

    produces this result:

    'aa bb cc':WordNumberOf('bb')=2 'bb':WordNumberIn('aa bb cc')=2

  2. You can use WordNumberIn and Word as "quick and dirty" NamedArraylists:

    %x = 'PA' %w = %x:WordNumberIn - ('MA PA MN') %s = ('Massachusetts Pennsylvania Minnesota'):Word(%w) Print 'Full state name:' And %s

    However, as the number of words grows large, repeated use of WordNumberIn is less efficient than using a NamedArrayList.

See also