setGMName: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Applied Template:MacroFunction) |
No edit summary |
||
| (9 intermediate revisions by 4 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, tokenRef) | ||
setGMName(name, tokenRef, mapRef) | |||
</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|mapRef|The Name or ID 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]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 11 May 2024
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, tokenRef)
setGMName(name, tokenRef, mapRef)Parameters
name- A string that is set as the GM Name on the token.tokenRef- Either the tokenidor Token Name of the token that has its GM Name set. Defaults to the Current Token.mapRef- The Name or ID 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.
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.