getNotes

From RPTools Wiki
Revision as of 23:59, 13 May 2024 by Taustin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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


Version Changes

  • 1.5.4 - Added id and mapname parameter options.


See also setNotes

Retrieved from "https://wiki.rptools.info/index.php?title=getNotes&oldid=35027"