setGMName: Difference between revisions

Latest revision as of 18:56, 11 May 2024

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

• Introduced in version 1.3b49

Sets the GM Name of a token.

setGMName(name)
setGMName(name, tokenRef)
setGMName(name, tokenRef, mapname)

Parameters

name - A string that is set as the GM Name on the token.
tokenRef - Either the token id or Token Name 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.

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.

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)]
}]

@@ Line 2: / Line 2: @@
 |name=setGMName
 |trusted=true
+|version=1.3b49
 |description=
-Sets the [[GM]] name of the [[Current Token]].
+Sets the GM Name of a token.
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: setGMName(name)]
+setGMName(name)
-</source>
+setGMName(name, tokenRef)
+setGMName(name, tokenRef, mapname)
+</syntaxhighlight>
+'''Parameters'''
+{{param|name|A string that is set as the GM Name on the token.}}
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that has its GM Name set. Defaults to the [[Current Token]].}}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
+{{Note|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.}}
+|examples=
+Sets the GM Name of the [[Current Token]] to {{code|New GM Name}}.
+<syntaxhighlight lang="mtmacro" line>
+[h: setGMName("New GM Name")]
+</syntaxhighlight>
+Sets the GM Name of all selected tokens to {{code|New GM Name}}.
+<syntaxhighlight lang="mtmacro" line>
+[h: SelectedTokens = getSelected()]
+[h,foreach(TokenID, SelectedTokens), code:
+{
+[h: setGMName("New GM Name", TokenID)]
+}]
+</syntaxhighlight>
+|also=
+{{func|getGMName}}
+|changes=
+{{change|1.3b51|Added {{code|id}} parameter option.}}
+{{change|1.5.9|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Token Function]]