getSelectedNames: Difference between revisions
Jump to navigation
Jump to search
m (Gets all selected tokens, not just NPCs) |
(Replaced "getSelected" by "getSelectedNames") |
||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getSelectedNames() | |||
getSelectedNames(delim) | |||
</source> | </source> | ||
{{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. | ||
| Line 18: | Line 18: | ||
To display the names of all of the selected [[Token:token|token]]s on the current [[Map:map|map]] use. | To display the names of all of the selected [[Token:token|token]]s on the current [[Map:map|map]] use. | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: names = | [h: names = getSelectedNames()] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</source> | </source> | ||
Revision as of 09:57, 9 September 2009
getSelectedNames() Function
• Introduced in version 1.3b48
Returns a list containing the names 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
getSelectedNames()
getSelectedNames(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 selected tokens on the current map use.
[h: names = getSelectedNames()]
[foreach(name, names, "<br>"): name]
Version Changes
- 1.3b49 - Added
jsondelimiter option. - 1.3b51 - No longer a trusted function.