setGMName

From RPTools Wiki
Jump to navigationJump to search

setGMName() Function

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

Introduced in version 1.3b49
Sets the GM Name of a token.

Usage

setGMName(name)
setGMName(name, id)
setGMName(name, id, mapname)

Parameters

  • name - A string that is set as the GM Name on the token.
  • id - The token id of the token that has its GM Name set. Defaults to the Current Token.
  • mapname - The name of the map to find the token. Defaults to the current map.

Examples

Sets the GM Name of the Current Token to New GM Name.
[h: setGMName("New GM Name")]

Sets the GM Name of all selected tokens to New GM Name.

[h: SelectedTokens = getSelected()]
[h,foreach(TokenID, SelectedTokens), code:
{
[h: setGMName("New GM Name", TokenID)]
}]

See Also

Version Changes

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