setGMName: Difference between revisions

Revision as of 06:15, 4 June 2009

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, id)

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.

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>
 setGMName(name)
+</source>
+<source lang="mtmacro" line>
 setGMName(name, id)
 </source>
+'''Parameters'''
+{{param|name|A string that is set as the GM Name on the token.}}
+{{param|id|The token id of the token that has its GM Name set. Defaults to the [[Current Token]].}}
+|examples=
+Sets the GM Name of the [[Current Token]] to {{code|New GM Name}}.
+<source lang="mtmacro" line>
+[h: setGMName("New GM Name")]
+</source>
+Sets the GM Name of all selected tokens to {{code|New GM Name}}.
+<source lang="mtmacro" line>
+[h: SelectedTokens = getSelected()]
+[h,foreach(TokenID, SelectedTokens), code:
+{
+[h: setGMName("New GM Name", TokenID)]
+}]
+</source>
+|also=
+{{func|getGMName}}
 |changes=