getGMName

From RPTools Wiki
Jump to navigation Jump 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 of usage.

getGMName() Function

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

Introduced in version 1.3b49
Returns the GM Name of a token as a string.

Usage

getGMName()
getGMName(tokenRef)
getGMName(tokenRef, mapRef)

Parameter

  • tokenRef - Either the token id or Token Name of the token that has its GM Name returned, defaults to the Current Token.
  • 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.


Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.9 - Added mapname parameter option.