setNotes: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function setNotes== Sets the Token:notes of the Token:Current Token. ===Usage=== <source lang="mtmacro" line> [h: setNotes(notes)] </source>) |
No edit summary |
||
(9 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
= | {{stub}} | ||
Sets the [[ | {{MacroFunction | ||
|name=setNotes | |||
|version=1.3b48 | |||
|description= | |||
Sets the [[Introduction to Tokens#Notes|notes]] of the [[Current Token]]. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
setNotes(notes) | |||
setNotes(notes, id) | |||
setNotes(notes, id, mapname) | |||
</syntaxhighlight> | |||
}} | |||
= | '''Parameter''' | ||
{{param|notes|The notes to set on the token. | |||
[ | {{param|id|The token {{code|id}} of the token to set the notes on. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|changes= | |||
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | |||
See also [[getNotes]] | |||
[[Category:Token Function]] |
Latest revision as of 20:48, 14 March 2023
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, id)
setNotes(notes, id, mapname)
Parameter
notes
- The notes to set on the token.id
- The tokenid
of the token to set the notes on.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.
See also getNotes