getGMNotes: Difference between revisions

Latest revision as of 18:35, 20 April 2023

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

Parameter

id - The token id of the token to get the GM notes from.
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.

}}

@@ Line 1: / Line 1: @@
-==Function getGMNotes==
+{{MacroFunction
-{{ProposedChange}}
+|name=getGMNotes
-{{TrustedOnlyFunction}}
+|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]].
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getGMNotes()
+getGMNotes(id)
+getGMNotes(id, mapname)
+</syntaxhighlight>
+'''Parameter'''
+{{param|id|The token {{code|id}} of the token to get the GM notes from. {{TrustedParameter}} }}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
-===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]]