canSeeToken

canSeeToken() Function

• Introduced in version 1.3b77

Returns a json array of the points visible on the target token from the source token as an enumerated list. Default source is Current Token. The enumerated list will contain zero to five of the following values:

• TOP_RIGHT
• BOTTOM_RIGHT
• TOP_LEFT
• BOTTOM_LEFT
• CENTER

When a token is not visible, an empty json array is returned: '[]'

Usage

canSeeToken(target)
canSeeToken(target, source)
canSeeToken(target, source, mapRef)

Parameters

• target - Either the token id or Token Name of target token.
• source - Either the token id or Token Name of the source, i.e. viewing token.
• mapRef - The Name or ID of the map to find the two tokens. 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

<!-- Dragon token partially hidden by VBL from current token. -->
[r: canSeeToken("Dragon")]
<!-- Troll token completely hidden from Elf token. -->
[r: canSeeToken("Troll","Elf")]
<!-- Troll token visible to Hero token. -->
[r: canSeeToken("Troll","Token")]

Returns:

["TOP_LEFT", "TOP_RIGHT", "CENTER"]
[]
["TOP_LEFT", "BOTTOM_LEFT", "TOP_RIGHT", "BOTTOM_RIGHT", "CENTER"]

See Also

isVisible()

Version Changes

• 1.5.4 - Added mapname parameter option.