getNotes: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
No edit summary |
||
| (12 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getNotes | |name=getNotes | ||
|description=Returns the [[Notes|token notes]] for the [[Current Token|Current Token]]. | |version=1.3b48 | ||
|description=Returns the [[Introduction to Tokens#Notes|token notes]] for the [[Current Token|Current Token]]. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getNotes() | |||
</ | getNotes(tokenRef) | ||
getNotes(tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{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]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 13 May 2024
getNotes() Function
• Introduced in version 1.3b48
Returns the token notes for the Current Token.
Usage
getNotes()
getNotes(tokenRef)
getNotes(tokenRef, mapRef)
Parameter
tokenRef- Either the tokenidor 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.
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.
See also setNotes