getNPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getNPCs== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a Macros:string list containing the ids of the Token:NPC tokens on the current Map:map. <source lan...)
 
No edit summary
Line 14: Line 14:
To display the ids of all of the [[Token:NPC token|NPC token]]s on the current [[Map:map|map]] use.
To display the ids of all of the [[Token:NPC token|NPC token]]s on the current [[Map:map|map]] use.
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: ids = getNPCNames()]
[h: ids = getNPs()]
[foreach(id, ids, "<br>"): id]
[foreach(id, ids, "<br>"): id]
</source>
</source>

Revision as of 23:13, 1 December 2008

Function getNPCs

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

This function can only be called from a trusted macro

Returns a string list containing the ids of the NPC tokens on the current map.

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

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


Examples

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

[h: ids = getNPs()]
[foreach(id, ids, "<br>"): id]