getOwners: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getOwners()
getOwners()
getOwners(delim)
getOwners(delim)
Line 20: Line 20:
|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.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: names = getOwners()]
[h: names = getOwners()]
[foreach(name, names, "<br>"): name]
[foreach(name, names, "<br>"): name]

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

Version Changes

  • 1.3b49 - Added json delimiter option.
  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.