setGMName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setGMName(name) | setGMName(name) | ||
setGMName(name, id) | setGMName(name, id) | ||
setGMName(name, id, mapname) | setGMName(name, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|name|A string that is set as the GM Name on the token.}} | {{param|name|A string that is set as the GM Name on the token.}} | ||
| Line 20: | Line 20: | ||
|examples= | |examples= | ||
Sets the GM Name of the [[Current Token]] to {{code|New GM Name}}. | Sets the GM Name of the [[Current Token]] to {{code|New GM Name}}. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setGMName("New GM Name")] | [h: setGMName("New GM Name")] | ||
</ | </syntaxhighlight> | ||
Sets the GM Name of all selected tokens to {{code|New GM Name}}. | Sets the GM Name of all selected tokens to {{code|New GM Name}}. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: SelectedTokens = getSelected()] | [h: SelectedTokens = getSelected()] | ||
[h,foreach(TokenID, SelectedTokens), code: | [h,foreach(TokenID, SelectedTokens), code: | ||
| Line 31: | Line 31: | ||
[h: setGMName("New GM Name", TokenID)] | [h: setGMName("New GM Name", TokenID)] | ||
}] | }] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 21:03, 14 March 2023
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
idparameter option. - 1.5.9 - Added
mapnameparameter option.