setGMNotes: Difference between revisions

Latest revision as of 23:59, 10 May 2024

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

• Introduced in version 1.3b48

Sets the GM notes of the Current Token.

setGMNotes(notes)
setGMNotes(notes, tokenRef)
setGMNotes(notes, tokenRef, mapRef)

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.
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.

@@ Line 1: / Line 1: @@
-==Function setGMNotes==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=setGMNotes
-Sets the [[GM]] notes of the [[Token:Current Token|Current Token]].
+|trusted=true
+|version=1.3b48
+|description=
+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, tokenRef)
+setGMNotes(notes, tokenRef, mapRef)
+</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|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.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
+}}
+}}
+[[Category:Token Function]]