getTokenOpacity

getTokenOpacity() Function

• Introduced in version 1.4.2.0

Returns the opacity value of the corresponding token.

Usage

getTokenOpacity()
getTokenOpacity(tokenRef)
getTokenOpacity(tokenRef, mapRef)

Parameters

• tokenRef - OPTIONAL: Either the token id or Token Name 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. 

• mapRef - OPTIONAL: 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.

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.