canSeeToken: Difference between revisions

Revision as of 15:16, 8 December 2010

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

• Introduced in version 1.3b77

Returns a json array of the points visible on the token as an enumerated list. The enumerated list will contain zero to five of the following values:

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

canSeeToken(id|name)

@@ Line 4: / Line 4: @@
 |version=1.3b77
 |description=
-Returns the 0-4 points of the token's footprint rectangle
+Returns a json array of the points visible on the token as an enumerated list.  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=