canSeeToken: Difference between revisions
Jump to navigation
Jump to search
Jfrazierjr (talk | contribs) (New page: place holder) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
(10 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{MacroFunction | |||
|name=canSeeToken | |||
|version=1.3b77 | |||
|description= | |||
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= | |||
<syntaxhighlight lang="mtmacro"> | |||
canSeeToken(target) | |||
canSeeToken(target, source) | |||
canSeeToken(target, source, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|target|Either the token ID or name of the target token.}} | |||
{{param|source|Either the token ID or name of the source, i.e. viewing token.}} | |||
{{param|mapname|The name of the map to find the two tokens. Defaults to the current map.}} | |||
|example= | |||
<syntaxhighlight lang="mtmacro" line> | |||
<!-- 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")] | |||
</syntaxhighlight> | |||
Returns: | |||
<syntaxhighlight lang="javascript"> | |||
["TOP_LEFT", "TOP_RIGHT", "CENTER"] | |||
[] | |||
["TOP_LEFT", "BOTTOM_LEFT", "TOP_RIGHT", "BOTTOM_RIGHT", "CENTER"] | |||
</syntaxhighlight> | |||
|also= [[isVisible|isVisible()]] | |||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[Category:Sight Function]] | |||
[[Category:Token Function]] |
Revision as of 18:56, 14 March 2023
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
Usage
canSeeToken(target)
canSeeToken(target, source)
canSeeToken(target, source, mapname)
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
<!-- 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
Version Changes
- 1.5.4 - Added
mapname
parameter option.