getOwners: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(Applied Template:MacroFunction)
m (Text replacement - "<source" to "<syntaxhighlight")
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{stub|Examples using new functionality.}}
{{MacroFunction
{{MacroFunction
|name=getOwners
|name=getOwners
|description=Returns a string list containing the names of the owners of the [[Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter.
|version=1.3b48
* If the delimiter is not specified then a [[String List|string list]] is returned with the default value of {{code|","}} is used.
|description=
* If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned.
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.  
* Otherwise a [[String List|string list]] is returned with the delimiter passed in.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: names = getOwners()]
getOwners()
[h: names = getOwners(delim)]
getOwners(delim)
</source>
getOwners(delim, id)
{{code|delim}} is the delimiter used to separate the values in the [[String List|string list]] which defaults to {{code|",""}} if not specified.
getOwners(delim, id, 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|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=
To display the [[Owners|owners]] of the current [[Token|token]] use.
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()]
[foreach(name, names, "<br>"): name]
[foreach(name, names, "<br>"): name]
</source>
</syntaxhighlight>
 
|also=
[[isOwnedByAll|isOwnedByAll()]],
[[isOwner|isOwner()]]


|changes=
|changes=
* '''1.3b49''' - Added {{code|json}} delimiter option.
{{change|1.3b49|Added {{code|json}} delimiter option.}}
 
{{change|1.3b51|Added {{code|id}} parameter option.}}
|also=
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
[[foreach|foreach()]]
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 20:30, 14 March 2023

 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 token id 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.

Example

To display the owners of the Current Token use. 
[h: names = getOwners()]
[foreach(name, names, "<br>"): name]

See Also

isOwnedByAll(), isOwner()

Version Changes

  • 1.3b49 - Added json delimiter option.
  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=getOwners&oldid=16003"