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

<source lang="mtmacro"> canSeeToken(target) canSeeToken(target, source) canSeeToken(target, source, mapname) </syntaxhighlight> Parameters

• target - Either the token ID or name of the target token.
• source - Either the token ID or name of the source, i.e. viewing token.
• mapname - The name of the map to find the two tokens. Defaults to the current map.

Example

<source lang="mtmacro" line>

[r: canSeeToken("Dragon")] [r: canSeeToken("Troll","Elf")] [r: canSeeToken("Troll","Token")]

</syntaxhighlight> Returns: <source lang="javascript"> ["TOP_LEFT", "TOP_RIGHT", "CENTER"] [] ["TOP_LEFT", "BOTTOM_LEFT", "TOP_RIGHT", "BOTTOM_RIGHT", "CENTER"]

</syntaxhighlight>

See Also

isVisible()

Version Changes

• 1.5.4 - Added mapname parameter option.