getGMNotes

From RPTools Wiki
(Redirected from macros:Functions:getGMNotes)
Jump to navigation Jump to search

getGMNotes() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b48
Returns the GM notes from the Current Token.

Usage

getGMNotes()
getGMNotes(tokenRef)
getGMNotes(tokenRef, mapRef)

Parameter

  • tokenRef - Either the token id or Token Name of the token.

     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.
Retrieved from "https://rptools.hyperbooks.com/index.php?title=getGMNotes&oldid=17974"