From RPTools Wiki
Jump to navigation Jump to search

setTokenOpacity() Function

Introduced in version
Sets the opacity value of the corresponding token.


setTokenOpacity(value, id)
setTokenOpacity(value, id, mapname)


  • value - The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.
  • id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.

Returns The opacity value that was set.

Note If opacity is below about 20%, it becomes increasingly difficult to see the token. At 0%, it is completely invisible, even to the Gamemaster. If you can't find it, use the Map Explorer panel.


[h: setTokenOpacity(0.5, "Dragon")]
[h, token("Dragon"): setTokenOpacity(0.75)]

Version Changes

  • 1.5.4 - Added mapname parameter option.