getLastPath: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(6 intermediate revisions by 4 users not shown)
Line 6: Line 6:
|usage=
|usage=


<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: getLastPath()]
[r: getLastPath()]
</source>
[r: getLastPath(units)]
</syntaxhighlight>


'''Parameters'''
* {{code|units}} - If set to {{false}}, the coordinate is a location on the grid in ''cells''. Defaults to {{true}}, where the coordinate is in ''Distance Per Cell'' ''units'' (in other words 0:distance in cells, 1: distance in pixels)'.


{{stub}}
 
 
{{stub|example needed}}
}}
}}
[[Category:Miscellaneous Function]]
[[Category:Miscellaneous Function]]

Latest revision as of 23:59, 14 March 2023

getLastPath() Function

Introduced in version 1.3.b74
Returns a json array of the coordinates of every step in the last movement path of the impersonated token. The coordinates are json objects with the keys x and y.

Usage

[r: getLastPath()]
[r: getLastPath(units)]

Parameters

  • units - If set to false(0), the coordinate is a location on the grid in cells. Defaults to true(1), where the coordinate is in Distance Per Cell units (in other words 0:distance in cells, 1: distance in pixels)'.



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