setNotes: 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 4 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the [[ | Sets the [[Introduction to Tokens#Notes|notes]] of the [[Current Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setNotes(notes) | |||
</ | setNotes(notes, tokenRef) | ||
setNotes(notes, tokenRef, mapRef) | |||
</syntaxhighlight> | |||
}} | }} | ||
'''Parameter''' | |||
{{param|notes|The notes to set on the token. | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to set the 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.}} | |||
}} | |||
See also [[getNotes]] | |||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 11 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
setNotes() Function
• Introduced in version 1.3b48
Sets the notes of the Current Token.
Usage
setNotes(notes)
setNotes(notes, tokenRef)
setNotes(notes, tokenRef, mapRef)
Parameter
notes- The notes to set on the token.tokenRef- Either the tokenidor Token Name of the token to set the 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.
See also getNotes