movedOverPoints: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 3: | Line 3: | ||
|version=1.3.b75 | |version=1.3.b75 | ||
|description= | |description= | ||
Is used 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 onTokenMove-events macro.args). | |||
{{code|movedOverPoints}} returns a json array with coordinates of all cells that have been a) in the defined shape and b) traversed by the token. | {{code|movedOverPoints}} returns a json array with coordinates of all cells that have been a) in the defined shape and b) traversed by the token. | ||
|usage= | |usage= | ||
| Line 23: | Line 20: | ||
[r: movedOverPoints(jsonArray)] | [r: movedOverPoints(jsonArray)] | ||
</source> | </source> | ||
{{stub|lastPath-format specified, define/explain return value, examples}} | {{stub|lastPath-format specified, define/explain return value, examples}} | ||
}} | }} | ||
[[Category:Miscellaneous Function]] | [[Category:Miscellaneous Function]] | ||
Revision as of 22:11, 6 March 2019
movedOverPoints() Function
• Introduced in version 1.3.b75
Is used 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 getLastPath() or the onTokenMove-events macro.args).
movedOverPoints returns a json array with coordinates of all cells that have been a) in the defined shape and b) traversed by the token.Usage
<!-- 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", 0, "y", 100)
)]
<!-- check if token in context has moved through that shape -->
[r: movedOverPoints(jsonArray)]
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