setGMNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 2: Line 2:
|name=setGMNotes
|name=setGMNotes
|trusted=true
|trusted=true
|version=1.3b48
|description=
|description=
Sets the [[GM]] notes of the [[Token:Current Token|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>
[h: setGMNotes(notes)]
setGMNotes(notes)
</source>
setGMNotes(notes, id)
setGMNotes(notes, id, mapname)
</syntaxhighlight>
 
'''Parameter'''
{{param|notes|The GM notes to set on the token.
{{param|id|The token {{code|id}} of the token to set the GM notes on. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 
|changes=
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
 
 
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 22:57, 9 May 2023

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, id)
setGMNotes(notes, id, mapname)

Parameter

  • notes - The GM notes to set on the token.
  • id - The token id of the token 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.