getDistance

Contents 1 getDistance() Function 1.1 Usage 1.2 Example 1.3 See Also 1.4 Version Changes

getDistance() Function

Returns the distance between two tokens or objects.

Usage

Parameters

• target - The id of the token that the distance is measured to.
• units - If set to false(0), the distance is given in cells, otherwise the default is to return the distance in Distance Per Cell units.
• source - The id of the token to measure the distance from, the default is the current token.
• metric - The movement metric to use which defaults to the movement metric in the users preferences, the metric can be one of the following strings
  • NO_GRID - The grid is ignored and straight line distance between the tokens is returned.
  • ONE_TWO_ONE - First Diagonal movement costs 1, second 2, and so on (Square grid only).
  • ONE_ONE_ONE - Diagonal movement costs a single square (Square grid only).
  • MANHATTAN - Diagonal movement costs 2 (Square grid only).
  • NO_DIAGONALS - No diagonal movement is allowed (Square grid only).

Example

To get the distance from the current token to the Altar.

To get the distance between the Altar and the Sacrifice in the number of squares or hexes.

To get the distance between the Altar and the Sacrifice in map distance units.

To get the straight line distance between the Altar and the Sacrifice.

See Also

getDistanceToXY() getTokens()

Version Changes

• 1.3b55 - Added the optional metric argument.

Token: A visual marker representing a character, monster, or NPCTrusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro: A series of text instructions used to automate processes in MapTool.Map: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.