getNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "<source" to "<syntaxhighlight")
No edit summary
Line 2: Line 2:
|name=getNotes
|name=getNotes
|version=1.3b48
|version=1.3b48
|description=Returns the [[introduction to Tokens#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=

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


Version Changes

  • 1.5.4 - Added id and mapname parameter options.


See also setNotes