getGMNotes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
getGMNotes() | getGMNotes() | ||
getGMNotes(tokenRef) | getGMNotes(tokenRef) | ||
getGMNotes(tokenRef, | getGMNotes(tokenRef, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token. {{TrustedParameter}} }} | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token. {{TrustedParameter}} }} | ||
{{param| | {{param|mapRef|The Name or ID 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 one 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 23:59, 29 August 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(tokenRef)
getGMNotes(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor 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
idandmapnameparameter options.