getNotes: Difference between revisions

Latest revision as of 23:59, 13 May 2024

• Introduced in version 1.3b48

getNotes()
getNotes(tokenRef)
getNotes(tokenRef, mapRef)

Parameter

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