token.gm name: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(End of adds to Special Variable category.)
No edit summary
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The variable ''token.gm_name'' allows programmatic querying and setting of the token's [[Token:GM_Name|GM Name]] (the second text field in the screenshot of the Edit Token dialog).  
The variable ''token.gm_name'' allows programmatic querying and setting of the token's [[Introduction to Tokens|GM Name]] (the second text field in the screenshot of the Edit Token dialog).
 
''token.gm_name'' is only a valid expression in a trusted macro.


[[Image:Edittoken-name-and-label.jpg]]
[[Image:Edittoken-name-and-label.jpg]]
Line 6: Line 8:


===Getting the Token GM Name===
===Getting the Token GM Name===
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:secretName=token.gm_name]
[h:secretName=token.gm_name]
GM's Name: [secretName]
GM's Name: [secretName]
</source>
</syntaxhighlight>


Outputs the value of ''token.gm_name''.
Outputs the value of ''token.gm_name''.


===Setting the Token GM Name===
===Setting the Token GM Name===
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:token.gm_name = "Soldier"]
[h:token.gm_name = "Soldier"]
</source>
</syntaxhighlight>


Sets the value of ''token.gm_name'' to "Soldier."
Sets the value of ''token.gm_name'' to "Soldier."
Line 26: Line 28:
[[Category:Special Variable]]
[[Category:Special Variable]]
{{DISPLAYTITLE:token.gm_name}}
{{DISPLAYTITLE:token.gm_name}}
[[Category:Macro Function]]

Latest revision as of 23:59, 4 July 2023

The variable token.gm_name allows programmatic querying and setting of the token's GM Name (the second text field in the screenshot of the Edit Token dialog).

token.gm_name is only a valid expression in a trusted macro.

Examples

Getting the Token GM Name

[h:secretName=token.gm_name]
GM's Name: [secretName]

Outputs the value of token.gm_name.

Setting the Token GM Name

[h:token.gm_name = "Soldier"]

Sets the value of token.gm_name to "Soldier."

Related Pages