getNPCNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getNPCNames== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a Macros:string list containing the names of the Token:NPC tokens on the current Map:map. <sour...)
 
No edit summary
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Function getNPCNames==
{{MacroFunction
{{ProposedChange}}
|name=getNPCNames
{{TrustedOnlyFunction}}
|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 [[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 {{code|json}} then a [[JSON Array]] is returned.
* Otherwise a [[String List{{!}}string list]] is returned with the delimiter passed in.
&nbsp;


Returns a [[Macros:string list|string list]] containing the names of the [[Token:NPC token|NPC token]]s on the current [[Map:map|map]].
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: macros = getNPCNames()]
[h: macros = getNPCNames()]
[h: macros = getNPCNames(delim)]
[h: macros = getNPCNames(delim)]
</source>
</syntaxhighlight>
delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to ',' 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=
===Examples===
To display the names of all of the [[Introduction_to_Tokens#Token_Type{{!}}NPC token]]s on the current [[Introduction to Mapping|map]] use.
To display the names of all of the [[Token:NPC token|NPC token]]s on the current [[Map:map|map]] use.
<syntaxhighlight lang="mtmacro" line>
<source lang="mtmacro" line>
[h: names = getNPCNames()]
[h: names = getNPCNames()]
[foreach(name, names, "<br>"): name]
[foreach(name, names, "<br>"): name]
</source>
</syntaxhighlight>
|changes=
* '''1.3b49''' - Added {{code|json}} delimiter option.
|also=
{{roll|foreach}}
}}
[[Category:Find Function]]

Latest revision as of 17:04, 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 json then 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 json delimiter option.