getGMNotes: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns the [[ | |description=Returns the [[Introduction to Tokens|GM notes]] from the [[Current Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getGMNotes() | getGMNotes() | ||
</ | getGMNotes(tokenRef) | ||
getGMNotes(tokenRef, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token. {{TrustedParameter}} }} | |||
{{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 one token has the same name can produce unexpected results.}} | |||
|changes= | |||
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 16:40, 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, mapname)Parameter
tokenRef- Either the tokenidor Token Name of the token.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
idandmapnameparameter options.