getGMNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:
{{param|id|The token {{code|id}} of the token to get the GM notes from. Will also work with [[getTokenName|Token Name]] {{TrustedParameter}} }}  
{{param|id|The token {{code|id}} of the token to get the GM notes from. Will also work with [[getTokenName|Token Name]] {{TrustedParameter}} }}  
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than on token has the same name can produce unexpected results.}}
{{Note|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.}}





Revision as of 01:08, 9 May 2024

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(id)
getGMNotes(id, mapname)

Parameter

  • id - The token id of the token to get the GM notes from. Will also work with Token Name

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


}}