getOwners

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

• 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

isOwnedByAll(), isOwner()

Version Changes

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