getNotes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
|name=getNotes | |name=getNotes | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns the [[Notes|token notes]] for the [[Current Token|Current Token]]. | |description=Returns the [[Introduction to Tokens#Notes|token notes]] for the [[Current Token|Current Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getNotes() | getNotes() | ||
</ | getNotes(id) | ||
getNotes(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token to get the notes from. {{TrustedParameter}} }} | |||
{{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]] | See also [[setNotes]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 16:11, 9 May 2023
getNotes() Function
• Introduced in version 1.3b48
Returns the token notes for the Current Token.
Usage
getNotes()
getNotes(id)
getNotes(id, mapname)
Parameter
id- The tokenidof 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.
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.
See also setNotes