getNPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
 
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Function getNPCs==
{{MacroFunction
{{TrustedOnlyFunction}}
|name=getNPC
|trusted=true
|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 {{code|json}} then a [[JSON Array|json array]] is returned.
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
 


Returns a list containing the ids of the [[Token:NPC token|NPC token]]s on the current [[Map:map|map]]. The type of the value returned depends on the delimiter parameter.
|usage=
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
<syntaxhighlight lang="mtmacro" line>
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
getNPC()
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in.
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.


<source lang="mtmacro" line>
|example=
[h: macros = getNPCs()]
To display the ids of all of the [[Introduction_to_Tokens#Token_Type|NPC token]]s on the current [[Introduction to Mapping|map]] use.
[h: macros = getNPCs(delim)]
<syntaxhighlight lang="mtmacro" line>
</source>
[h: ids = getNPC()]
delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to ',' if not specified.
[foreach(id, ids, "<br>"): id]
</syntaxhighlight>


|changes=
* '''1.3b49''' - Added {{code|json}} delimiter option.


===Examples===
|also=
To display the ids of all of the [[Token:NPC token|NPC token]]s on the current [[Map:map|map]] use.
{{roll|foreach}}
<source lang="mtmacro" line>
}}
[h: ids = getNPs()]
[[Category:Find Function]]
[foreach(id, ids, "<br>"): id]
</source>

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 json then 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

[foreach():]

Version Changes

  • 1.3b49 - Added json delimiter option.
Retrieved from "https://wiki.rptools.info/index.php?title=getNPC&oldid=35022"