setGMName: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
(5 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
|name=setGMName | |name=setGMName | ||
|trusted=true | |trusted=true | ||
|version=1.3b49 | |||
|description= | |description= | ||
Sets the | Sets the GM Name of a token. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setGMName( | setGMName(name) | ||
</ | setGMName(name, id) | ||
setGMName(name, id, mapname) | |||
</syntaxhighlight> | |||
'''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]].}} | |||
{{param|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 {{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]] | [[Category:Token Function]] |
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
id
parameter option. - 1.5.9 - Added
mapname
parameter option.