setGMNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Unifying Current Token red link.)
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 4: Line 4:
|version=1.3b48
|version=1.3b48
|description=
|description=
Sets the [[GM]] notes of the [[Current Token]].  
Sets the [[Introduction to Game Hosting#Server Options and Settings|GM]] notes of the [[Current Token]].  


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setGMNotes(notes)
setGMNotes(notes)
</source>
setGMNotes(notes, tokenRef)
setGMNotes(notes, tokenRef, mapname)
</syntaxhighlight>
 
'''Parameter'''
{{param|notes|The GM notes to set on the token.
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] to set the GM notes on. {{TrustedParameter}} }}
{{param|mapname|The name 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.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
 
 
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 20:43, 10 May 2024

setGMNotes() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b48
Sets the GM notes of the Current Token.

Usage

setGMNotes(notes)
setGMNotes(notes, tokenRef)
setGMNotes(notes, tokenRef, mapname)

Parameter

  • notes - The GM notes to set on the token.
  • tokenRef - Either the token id or Token Name to set the GM notes on.

     Note: This parameter can only be used in a Trusted Macro

  • mapname - The name 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.