getNPC: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getNPCs moved to getNPCs) |
No edit summary |
||
| (13 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=getNPC | ||
|trusted=true | |trusted=true | ||
|description=Returns a list containing the ids of the [[ | |version=1.3b48 | ||
|description=Returns a list containing the ids 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|json array]] is returned. | * If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned. | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
| |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getNPC() | |||
getNPC(delim) | |||
</ | </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. | ||
|example= | |example= | ||
To display the ids of all of the [[ | To display the ids 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: ids = | [h: ids = getNPC()] | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
| Line 25: | Line 27: | ||
|also= | |also= | ||
{{roll|foreach}} | |||
}} | }} | ||
[[Category: | [[Category:Find Function]] | ||
Latest revision as of 23:59, 20 April 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
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
getNPC()
getNPC(delim)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.
[h: ids = getNPC()]
[foreach(id, ids, "<br>"): id]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.