getNPCNames: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 13: | Line 13: | ||
[h: macros = getNPCNames()] | [h: macros = getNPCNames()] | ||
[h: macros = getNPCNames(delim)] | [h: macros = getNPCNames(delim)] | ||
</ | </syntaxhighlight> | ||
{{code|delim}} is the delimiter used to separate the values in the [[String List{{!}}string list]] which defaults to {{code|","}} if not specified. | {{code|delim}} is the delimiter used to separate the values in the [[String List{{!}}string list]] which defaults to {{code|","}} if not specified. | ||
| Line 21: | Line 21: | ||
[h: names = getNPCNames()] | [h: names = getNPCNames()] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
* '''1.3b49''' - Added {{code|json}} delimiter option. | * '''1.3b49''' - Added {{code|json}} delimiter option. | ||
Revision as of 18:35, 14 March 2023
getNPCNames() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Returns a list containing the names 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
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
<source lang="mtmacro" line>
[h: macros = getNPCNames()]
[h: macros = getNPCNames(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 names of all of the NPC tokens on the current map use.
<source lang="mtmacro" line>
[h: names = getNPCNames()]
[foreach(name, names, "
"): name]
See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.