getTokenOpacity

From RPTools Wiki
Jump to navigation Jump to search

getTokenOpacity() Function

Introduced in version 1.4.2.0
Returns the opacity value of the corresponding token.

Usage

getTokenOpacity()
getTokenOpacity(id)
getTokenOpacity(id, mapname)

Parameters

  • id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.

Example

The opacity for the Dragon token is: [r: getTokenOpacity("Dragon")]
[h, token("Dragon"): opacity = getTokenOpacity()]


Version Changes

  • 1.5.4 - Added mapname parameter option.