getGMName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{MacroFunction | |||
Returns the GM Name of | |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(id) | ||
getGMName(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token that has its GM Name returned, defaults to the [[Current Token]].}} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|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 18:34, 14 March 2023
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(id)
getGMName(id, mapname)Parameter
id- The tokenidof the token that has its GM Name returned, defaults to the Current Token.mapname- The name of the map to find the token. Defaults to the current map.
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.9 - Added
mapnameparameter option.