getOwned

From RPTools Wiki
Jump to navigationJump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: examples for all parameters

getOwned() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b48
Returns a list containing the ids of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.
  • If the delimiter is not specified then a string list is returned with the default value of "," is used.
  • If the delimiter json then a json array is returned.
  • Otherwise a string list is returned with the delimiter passed in.
 

Usage

getOwned()
getOwned(player)
getOwned(player, delim)
getOwned(player, delim, mapname)

Parameters

  • player - The player for which you want to retrieve the owned tokens, defaults to the current player.
  • delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.
  • mapname - The name of the map to find the tokens. Defaults to the current map.

Example

To display the ids of all of the tokens on the current map by the Player use.
[h: ids = getOwned(getPlayerName())]
[foreach(id, ids, "<br>"): id]

See Also

Version Changes

  • 1.3b49 - Added json delimiter option.
  • 1.5.8 - Added mapname parameter, made player parameter optional.