getGMName: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function getGMName== {{TrustedOnlyFunction}} Returns the GM Name of a Token:token. ===Usage=== <source lang="mtmacro" line> [h: name = getGMName()] </source>) |
No edit summary |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{MacroFunction | |||
Returns the GM Name of a | |name=getGMName | ||
|version=1.3b49 | |||
|trusted=true | |||
|description=Returns the GM Name of a token as a string. | |||
|usage= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
getGMName() | |||
</ | getGMName(tokenRef) | ||
getGMName(tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that has its GM Name returned, 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.}} | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.9|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[Category:Token Function]] | |||
Latest revision as of 23:59, 13 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples of usage.
getGMName() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b49
Returns the GM Name of a token as a string.
Usage
getGMName()
getGMName(tokenRef)
getGMName(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor Token Name of the token that has its GM Name returned, 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.
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.9 - Added
mapnameparameter option.