getPCNames: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getPCNames== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a string list containing the names of the Token:PC tokens on the current [[Map:map|m...) |
No edit summary |
||
| (14 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
== | {{MacroFunction | ||
{{ | |name=getPCNames | ||
{{ | |trusted=true | ||
|version=1.3b48 | |||
|description=Returns a list containing the names 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. | |||
| |||
|usage= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
getPCNames() | |||
getPCNames(delim) | |||
</ | </syntaxhighlight> | ||
delim is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to | {{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 names of all of the [[Introduction_to_Tokens#Token_Type|PC token]]s on the current [[Introduction to Mapping|map]] use. | |||
To display the names of all of the [[ | <syntaxhighlight lang="mtmacro" line> | ||
< | |||
[h: names = getPCNames()] | [h: names = getPCNames()] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
|changes= | |||
* '''1.3b49''' - Added {{code|json}} delimiter option. | |||
|also= | |||
{{roll|foreach}} | |||
}} | |||
[[Category:Token Function]] | |||
Latest revision as of 17:05, 20 April 2023
getPCNames() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Returns a list containing the names 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
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
getPCNames()
getPCNames(delim)delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.
Example
To display the names of all of the PC tokens on the current map use.
[h: names = getPCNames()]
[foreach(name, names, "<br>"): name]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.