getNPCNames: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns a list containing the names of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[ | |description=Returns a list containing the names of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[Introduction to Mapping|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 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. | * If the delimiter {{code|json}} then a [[JSON Array]] is returned. | ||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[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. | ||
|example= | |example= | ||
To display the names of all of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[ | To display the names of all of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[Introduction to Mapping|map]] use. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[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. | ||
Latest revision as of 23:59, 20 April 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
[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.
Example
To display the names of all of the NPC tokens on the current map use.
[h: names = getNPCNames()]
[foreach(name, names, "<br>"): name]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.