setGMNotes: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the [[GM]] notes of the [[Current Token]]. | Sets the [[Introduction to Game Hosting#Server Options and Settings|GM]] notes of the [[Current Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setGMNotes(notes) | setGMNotes(notes) | ||
</ | setGMNotes(notes, tokenRef) | ||
setGMNotes(notes, tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|notes|The GM notes to set on the token. | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] to set the GM notes on. {{TrustedParameter}} }} | |||
{{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.}} | |||
|changes= | |||
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 10 May 2024
setGMNotes() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Sets the GM notes of the Current Token.
Usage
setGMNotes(notes)
setGMNotes(notes, tokenRef)
setGMNotes(notes, tokenRef, mapRef)Parameter
notes- The GM notes to set on the token.tokenRef- Either the tokenidor Token Name to set the GM notes on.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.