getPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(New page: ==Function getPCs== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a string list containing the ids of the PC tokens on the current [[Map:map...)
 
No edit summary
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Function getPCs==
{{MacroFunction
{{ProposedChange}}
|name=getPC
{{TrustedOnlyFunction}}
|trusted=true
|version=1.3b48
|description=Returns a list containing the ids of the [[Introduction_to_Tokens#Token_Type|PC 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 [[Macros: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 [[Macros:string list|string list]] is returned with the delimiter passed in.
 


Returns a [[Macros:string list|string list]] containing the ids of the [[Token:PC token|PC token]]s on the current [[Map:map|map]].
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: macros = getPCs()]
getPC()
[h: macros = getPCs(delim)]
getPC(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  [[Macros:string list|string list]] which defaults to {{code|","}} if not specified.


|example=
To display the ids of all of the [[Introduction_to_Tokens#Token_Type|PC token]]s on the current [[Introduction to Mapping|map]] use.
<syntaxhighlight lang="mtmacro" line>
[h: ids = getPC()]
[foreach(id, ids, "<br>"): id]
</syntaxhighlight>


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

Latest revision as of 17:05, 20 April 2023

getPC() 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 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

getPC()
getPC(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 = getPC()]
[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=getPC&oldid=16685"