getMoveCount

From RPTools Wiki
Revision as of 04:17, 24 July 2019 by Phergus (talk | contribs)
Jump to navigation Jump to search

getMoveCount() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b76
Returns the token's last movement count in units. The count takes movement metric into account, and thus works on gridless, hex, and square grids. Two optional parameters allow you to set Fraction Only or Use Terrain Modifiers for determining returned movement count.

Usage

getMoveCount()
getMoveCount(fractionOnly)
getMoveCount(fractionOnly,useTerrainMods)

Parameters

  • fractionOnly - 0 for normal count; 1 for fractional count - only applies with 1-2-1 movement metric
  • useTerrainMods - 0 to ignore terrain modifiers; 1 to account for terrain modifiers


Version Changes

  • 1.5.0 - Added Fraction Only and Use Terrain Modifiers parameters.