movedOverPoints: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
|version=1.3.b75
|version=1.3.b75
|description=
|description=
Use to check if a token has moved through a shape that is defined by an array of cell coordinates (formatted like the one received from {{func|getLastPath}} or the {{code|onTokenMove}} events {{code|macro.args}}.  
Use to check if a token has moved through a shape that is defined by an array of pixel coordinates (formatted like the one received from {{func|getLastPath}} or the {{code|onTokenMove}} events {{code|macro.args}}.  


Returns a JSON array with coordinates of all cells that have been a) in the defined shape and b) traversed by the token.
Returns a JSON array with the top-left pixel coordinates of all cells that are) in the defined shape and b) were traversed by the token.


|usage=
|usage=

Revision as of 00:53, 29 March 2019

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: lastPath-format specified, define/explain return value, examples

movedOverPoints() Function

Introduced in version 1.3.b75
Use to check if a token has moved through a shape that is defined by an array of pixel coordinates (formatted like the one received from getLastPath() or the onTokenMove events macro.args. Returns a JSON array with the top-left pixel coordinates of all cells that are) in the defined shape and b) were traversed by the token.

Usage

movedOverPoints(points)

Parameters

  • points - JSON array of cell coordinate X/Y pairs that defines a polygon

Example

<!-- lets define a shape -->

[h: jsonArray = json.append("",
    json.set("", "x",   0, "y",   0),
    json.set("", "x",   0, "y", 100),
    json.set("", "x", 100, "y", 100),
    json.set("", "x",   100, "y", 0)
)]

<!-- check if token in context has moved through that shape -->
[r: movedOverPoints(jsonArray)]