getNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
getNotes()
getNotes()
getNotes(id)
getNotes(id, mapname)
</source>
</source>
}}
}}
'''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 21:01, 15 August 2019

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 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.


|changes=

  • 1.5.4 - Added id and mapname parameter options.

}}


See also setNotes