getOwners: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
No edit summary |
||
| Line 9: | Line 9: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getOwners() | getOwners() | ||
getOwners(delim) | getOwners(delim) | ||
getOwners(delim, id) | getOwners(delim, id) | ||
getOwners(delim, id, mapname) | |||
</source> | </source> | ||
'''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|id|The token {{code|id}} of the token which has its owners returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its owners returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
| Line 34: | Line 32: | ||
{{change|1.3b49|Added {{code|json}} delimiter option.}} | {{change|1.3b49|Added {{code|json}} delimiter option.}} | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 19:50, 15 August 2019
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, id)
getOwners(delim, id, mapname)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.id- The tokenidof the token which has its owners returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.
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.