getOwners: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getOwners() | getOwners() | ||
getOwners(delim) | getOwners(delim) | ||
getOwners(delim, | getOwners(delim, tokenRef) | ||
getOwners(delim, | getOwners(delim, tokenRef, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|delim|The delimiter used to separate the values in the [[String List]], defaults to {{code|","}}. If set to {{code|"json"}}, this function will return a [[JSON Array]] instead of a [[String List]].}} | {{param|delim|The delimiter used to separate the values in the [[String List]], defaults to {{code|","}}. If set to {{code|"json"}}, this function will return a [[JSON Array]] instead of a [[String List]].}} | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its owners returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param| | {{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | ||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|example= | |example= | ||
To display the [[Introduction_to_Tokens#Ownership|owners]] of the [[Current Token]] use. | To display the [[Introduction_to_Tokens#Ownership|owners]] of the [[Current Token]] use. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: names = getOwners()] | [h: names = getOwners()] | ||
[foreach(name, names, "<br>"): name] | [foreach(name, names, "<br>"): name] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 23:59, 13 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples using new functionality.
getOwners() Function
• Introduced in version 1.3b48
Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.
Usage
getOwners()
getOwners(delim)
getOwners(delim, tokenRef)
getOwners(delim, tokenRef, mapRef)Parameters
delim- The delimiter used to separate the values in the String List, defaults to",". If set to"json", this function will return a JSON Array instead of a String List.tokenRef- Either the tokenidor Token Name of the token which has its owners returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Example
To display the owners of the Current Token use.
[h: names = getOwners()]
[foreach(name, names, "<br>"): name]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option. - 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.