getGMNotes: Difference between revisions

Latest revision as of 16:40, 29 August 2024

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

• Introduced in version 1.3b48

Returns the GM notes from the Current Token.

getGMNotes()
getGMNotes(tokenRef)
getGMNotes(tokenRef, mapname)

Parameter

tokenRef - Either the token id or Token Name of the token.
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.

@@ Line 1: / Line 1: @@
-==Function getGMNotes==
+{{MacroFunction
-{{TrustedOnlyFunction}}
+|name=getGMNotes
+|trusted=true
+|version=1.3b48
+|description=Returns the [[Introduction to Tokens|GM notes]] from the [[Current Token]].
-Returns the [[Token:GM notes|GM notes]] from a [[Token:token|token]].
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getGMNotes()
+getGMNotes(tokenRef)
+getGMNotes(tokenRef, mapname)
+</syntaxhighlight>
+'''Parameter'''
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token. {{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.}}
-===Usage===
-<source lang="mtmacro" line>
+|changes=
-[h: notes = getGMNotes()]
+{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
-</source>
+}}
+[[Category:Token Function]]