range

Calculates the distance between two units or positions on a map.

Function

Synopsis

btech.map.range( map, from, to )

Arguments

DbRef|Object map

The BattleTech map.

DbRef|Object|BtechPosition from

The starting unit or position.

DbRef|Object|BtechPosition to

The ending unit or position.

Returns

number range

The three-dimensional map distance.

Notes

Unit endpoints use their current three-dimensional positions and must be on the supplied map. A position with an explicit z uses that altitude; when z is omitted, the position uses the hex’s terrain elevation.

See Also

• btech
• btech.map