getOwners: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Function getOwners==
{{stub|Examples using new functionality.}}
{{MacroFunction
|name=getOwners
|version=1.3b48
|description=
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=
<syntaxhighlight lang="mtmacro" line>
getOwners()
getOwners(delim)
getOwners(delim, tokenRef)
getOwners(delim, tokenRef, mapname)
</syntaxhighlight>
'''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|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|mapname|The name 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.}}


Returns a [[Macros:string list|string list]] containing the names of the owners of the current [[Token:token|token]].
|example=
 
To display the [[Introduction_to_Tokens#Ownership|owners]] of the [[Current Token]] use.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: names = getOwners()]
[h: names = getOwners()]
[h: names = getOwners(delim)]
[foreach(name, names, "<br>"): name]
</source>
</syntaxhighlight>
delim is the delimiter used to separate the values in the  [[Macros:string list|string list]] which defaults to ',' if not specified.


|also=
[[isOwnedByAll|isOwnedByAll()]],
[[isOwner|isOwner()]]


===Examples===
|changes=
To display the [[Token:owners|owners]] of the current [[Token:token|token]] use.
{{change|1.3b49|Added {{code|json}} delimiter option.}}
<source lang="mtmacro" line>
{{change|1.3b51|Added {{code|id}} parameter option.}}
[h: names = getOwners()]
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
[foreach(name, names, "<br>"): name]
}}
</source>
[[Category:Token Function]]

Latest revision as of 20:48, 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, 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.
  • tokenRef - Either the token id or 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

  • mapname - The name 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 json delimiter option.
  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.