getPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Applied Template:MacroFunction, Corrected getPC to getPCs.)
Line 1: Line 1:
==Function getPC==
{{MacroFunction
{{TrustedOnlyFunction}}
|name=getPCs
 
|trusted=true
 
|description=Returns a list containing the ids of the [[Token:PC token|PC token]]s on the current [[Map:map|map]]. The type of the value returned depends on the delimiter parameter.  
Returns a list containing the ids of the [[Token:PC token|PC token]]s on the current [[Map:map|map]]. The type of the value returned depends on the delimiter parameter.  
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of {{code|","}} is used.
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used.
* If the delimiter {{code|json}} then a [[Macros:json array|json array]] is returned.
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)'''
* 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=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: macros = getPC()]
[h: macros = getPCs()]
[h: macros = getPC(delim)]
[h: macros = getPCs(delim)]
</source>
</source>
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  [[Macros:string list|string list]] which defaults to {{code|","}} if not specified.


 
|example=
===Examples===
To display the ids of all of the [[Token:PC token|PC token]]s on the current [[Map:map|map]] use.
To display the ids of all of the [[Token:PC token|PC token]]s on the current [[Map:map|map]] use.
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: ids = getPC()]
[h: ids = getPCs()]
[foreach(id, ids, "<br>"): id]
[foreach(id, ids, "<br>"): id]
</source>
</source>
|changes=
* '''1.3b49''' - Added {{code|json}} delimiter option.
|also=
[[foreach|foreach()]]
}}
[[Category:Token Function]]

Revision as of 03:19, 8 March 2009

getPCs() Function

 Note: This function can only be used in a Trusted Macro

Returns a list containing the ids of the PC 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 = getPCs()]
[h: macros = getPCs(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 PC tokens on the current map use.
[h: ids = getPCs()]
[foreach(id, ids, "<br>"): id]

See Also

Version Changes

  • 1.3b49 - Added json delimiter option.