setNotes

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