setNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setNotes(notes)]
setNotes(notes)
setNotes(notes, id)
setNotes(notes, id, mapname)
</source>
</source>
}}
}}


'''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]]
See also [[getNotes]]


[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 21:00, 15 August 2019

 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 token id 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