getSelected: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getSelected moved to getSelected) |
No edit summary |
||
| (10 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getSelected | |name=getSelected | ||
| | |version=1.3b48 | ||
|description= | |description= | ||
Returns a list containing the ids of the selected [[Token: | Returns a list containing the ids of the selected [[Token:token|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 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 [[ | * 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. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
| |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getSelected() | |||
getSelected(delim) | |||
</ | </syntaxhighlight> | ||
{{code|delim}} is the delimiter used to separate the values in the [[Macros:string list|string list]] which defaults to {{code|","}} 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= | |example= | ||
To display the ids of all of the selected [[Token:token|token]]s on the current [[ | To display the ids of all of the selected [[Token:token|token]]s on the current [[Introduction to Mapping|map]] use. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: ids = getSelected()] | [h: ids = getSelected()] | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
{{change|1.3b49|Added {{code|json}} delimiter option.}} | |||
{{change|1.3b51|No longer a trusted function.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 20 April 2023
getSelected() Function
• Introduced in version 1.3b48
Returns a list containing the ids of the selected 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
getSelected()
getSelected(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 selected tokens on the current map use.
[h: ids = getSelected()]
[foreach(id, ids, "<br>"): id]
Version Changes
- 1.3b49 - Added
jsondelimiter option. - 1.3b51 - No longer a trusted function.