getNPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetNPC to getNPC: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 13: Line 13:
getNPC()
getNPC()
getNPC(delim)
getNPC(delim)
</source>
</syntaxhighlight>
delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to {{code|","}} if not specified.
delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to {{code|","}} if not specified.


Line 21: Line 21:
[h: ids = getNPC()]
[h: ids = getNPC()]
[foreach(id, ids, "<br>"): id]
[foreach(id, ids, "<br>"): id]
</source>
</syntaxhighlight>


|changes=
|changes=

Revision as of 18:38, 14 March 2023

getNPC() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b48
Returns a list containing the ids of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.
  • If the delimiter is not specified then a string list is returned with the default value of "," is used.
  • If the delimiter json then a json array is returned.
  • Otherwise a string list is returned with the delimiter passed in.
 

Usage

<source lang="mtmacro" line> getNPC() getNPC(delim) </syntaxhighlight> delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.

Example

To display the ids of all of the NPC tokens on the current map use.

<source lang="mtmacro" line> [h: ids = getNPC()] [foreach(id, ids, "
"): id]

</syntaxhighlight>

See Also

Version Changes

  • 1.3b49 - Added json delimiter option.