getNPCNames: Difference between revisions

Revision as of 00:43, 12 February 2023

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 json then a JSON Array is returned.
Otherwise a string list is returned with the delimiter passed in.

[h: macros = getNPCNames()]
[h: macros = getNPCNames(delim)]

delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.

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

[h: names = getNPCNames()]
[foreach(name, names, "<br>"): name]

@@ Line 3: / Line 3: @@
 |trusted=true
 |version=1.3b48
-|description=Returns a list containing the names of the [[Introduction to Tokens#Token Type{{!}}NPC token]]s on the current [[Map{{!}}map]]. The type of the value returned depends on the delimiter parameter.
+|description=Returns a list containing the names of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[Map{{!}}map]]. The type of the value returned depends on the delimiter parameter.
 * If the delimiter is not specified then a [[String List{{!}}string list]] is returned with the default value of {{code|","}} is used.
 * If the delimiter {{code|json}} then a [[JSON Array]] is returned.
@@ Line 17: / Line 17: @@
 |example=
-To display the names of all of the [[Introduction to Tokens#Token Type{{!}}NPC token]]s on the current [[Map:map{{!}}map]] use.
+To display the names of all of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[Map:map{{!}}map]] use.
 <source lang="mtmacro" line>
 [h: names = getNPCNames()]