getNotes: Difference between revisions

Revision as of 16:11, 9 May 2023

• Introduced in version 1.3b48

getNotes()
getNotes(id)
getNotes(id, mapname)

Parameter

id - The token id of the token to get the 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 getNotes==
+{{MacroFunction
+|name=getNotes
+|version=1.3b48
+|description=Returns the [[Introduction to Tokens#Notes|token notes]] for the [[Current Token|Current Token]].
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getNotes()
+getNotes(id)
+getNotes(id, mapname)
+</syntaxhighlight>
-Returns the [[Token:notes | token notes]] for the current [[Token:token|token]].
-<source lang="mtmacro" line>
+'''Parameter'''
-[h: macros = getNotes()]
+{{param|id|The token {{code|id}} of the token to get the notes from. {{TrustedParameter}} }}
-</source>
+{{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.}}
+}}
+See also [[setNotes]]
+[[Category:Token Function]]