getGMNotes: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetGMNotes to getGMNotes: Converting page titles to lowercase) |
No edit summary |
||
| (5 intermediate revisions by the same user 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(id) | getGMNotes(id) | ||
getGMNotes(id, mapname) | getGMNotes(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|id|The token {{code|id}} of the token to get the GM notes from. {{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 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 tokenidof the token to get the GM notes from. Will also work with Token NameNote: 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.
}}