units

Lists the live units on a map.

Function

Synopsis

btech.map.units( map, filter )

Arguments

DbRef|Object map

The BattleTech map.

table|nil filter

An optional { origin = { x = x, y = y }, range = range } filter. The origin must be a valid map hex, and range must be a non-negative number. Range filtering is two-dimensional; unit altitude is ignored.

Returns

Object[] units

The matching unit handles.

See Also

• btech
• btech.map