getOwnedNames: Difference between revisions
Jump to navigation
Jump to search
(Fixed broken link) |
No edit summary |
||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|examples for all parameters}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getOwnedNames | |name=getOwnedNames | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns a list containing the names of the [[Token|token]]s on the current [[ | |description=Returns a list containing the names of the [[Token|token]]s on the current [[Introduction to Mapping|map]] that are owned by the specified player. The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[String List|string list]] is returned with the default value of {{code|","}} is used. | * If the delimiter is not specified then a [[String List|string list]] is returned with the default value of {{code|","}} is used. | ||
* If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned. | * If the delimiter {{code|json}} then a [[JSON Array|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> | ||
getOwnedNames(player) | getOwnedNames(player) | ||
getOwnedNames(player, delim) | getOwnedNames(player, delim) | ||
</ | getOwnedNames(player, delim, mapRef) | ||
{{ | </syntaxhighlight> | ||
'''Parameters''' | |||
{{param|player|The player for which you want to retrieve the owned tokens, defaults to the current player.}} | |||
{{param|delim|the delimiter used to separate the values in the [[String List|string list]] which defaults to {{code|","}} if not specified.}} | |||
{{param|mapRef|The Name or ID of the map to find the tokens. Defaults to the current map.}} | |||
|examples= | |examples= | ||
To display the ids of all of the [[Token|token]]s on the current [[ | To display the ids of all of the [[Token|token]]s on the current [[Introduction to Mapping|map]] by the Player use. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: names = getOwnedNames(getPlayerName())] | [h: names = getOwnedNames(getPlayerName())] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
{{change|1.3b49|Added {{code|json}} delimiter option.}} | |||
{{change|1.5.8|Added {{code|mapname}} parameter, made {{code|player}} parameter optional.}} | |||
|also= | |also= | ||
{{ | {{func|getOwned}} | ||
}} | }} | ||
[[Category:Find Function]] | [[Category:Find Function]] | ||
Latest revision as of 23:59, 24 April 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: examples for all parameters
getOwnedNames() 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 tokens on the current map that are owned by the specified player. 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
getOwnedNames(player)
getOwnedNames(player, delim)
getOwnedNames(player, delim, mapRef)Parameters
player- The player for which you want to retrieve the owned tokens, defaults to the current player.delim- the delimiter used to separate the values in the string list which defaults to","if not specified.mapRef- The Name or ID of the map to find the tokens. Defaults to the current map.
Examples
To display the ids of all of the tokens on the current map by the Player use.
[h: names = getOwnedNames(getPlayerName())]
[foreach(name, names, "<br>"): name]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option. - 1.5.8 - Added
mapnameparameter, madeplayerparameter optional.