btech.map on StompyMUX Documentation

blast_zones

Mon, 01 Jan 0001 00:00:00 +0000

Lists the blast zones configured on a map.

Function

Synopsis

btech.map.blast_zones( map )

Arguments

DbRef|Object map: The BattleTech map.

Returns

BtechBlastZone[] zones: The configured blast zones.

cargo_transfer_point

Mon, 01 Jan 0001 00:00:00 +0000

Returns a map’s cargo-transfer point.

Function

Synopsis

btech.map.cargo_transfer_point( map )

Arguments

DbRef|Object map: The BattleTech map.

Returns

BtechCargoTransferPoint|nil point: The configured point, or nil when unset.

elevation

Mon, 01 Jan 0001 00:00:00 +0000

Returns the elevation of a map hex.

Function

Synopsis

btech.map.elevation( map, hex )

Arguments

DbRef|Object map: The BattleTech map.
BtechHex hex: The zero-based map coordinates.

Returns

integer elevation: The hex elevation.

emit

Mon, 01 Jan 0001 00:00:00 +0000

Emits a message to units on a map.

Function

Synopsis

btech.map.emit( map, message, options )

Arguments

DbRef|Object map: The BattleTech map.
string message: The non-empty message to emit.
BtechMapEmitOptions|nil options: Optional audience, origin, and range controls.

Returns

None.

Notes

The all audience forbids origin and range. The range audience requires both and requires a non-negative range. A range emission uses two-dimensional distance when origin.z is omitted and three-dimensional distance when it is provided. The line_of_sight audience requires origin, forbids origin.z, and forbids range.

in_blast_zone

Mon, 01 Jan 0001 00:00:00 +0000

Tests whether a map hex lies in a configured blast zone.

Function

Synopsis

btech.map.in_blast_zone( map, hex )

Arguments

DbRef|Object map: The BattleTech map.
BtechHex hex: The zero-based map coordinates.

Returns

boolean inside: Whether the hex lies in a blast zone.

line_of_sight

Mon, 01 Jan 0001 00:00:00 +0000

Tests line of sight from a unit to another unit or hex.

Function

Synopsis

btech.map.line_of_sight( observer, target )

Arguments

DbRef|Object observer: The observing unit.
DbRef|Object|BtechHex target: The target unit or map coordinates.

Returns

BtechLineOfSight state: For a unit target, "none", "blocked", or "clear". "none" means the target is not visible or is on another map. For a hex target, only "blocked" or "clear".

link

Mon, 01 Jan 0001 00:00:00 +0000

Returns a child map’s parent-link configuration.

Function

Synopsis

btech.map.link( child )

Arguments

DbRef|Object child: The child BattleTech map.

Returns

BtechMapLink|nil link: The parent link, or nil when unset.

load

Mon, 01 Jan 0001 00:00:00 +0000

Loads map data from a named map file.

Function

Synopsis

btech.map.load( map, name )

Arguments

DbRef|Object map: The BattleTech map.
string name: The non-empty map-file name. It cannot contain .., /, or \.

Returns

None.

Notes

Loading replaces the map’s terrain data and clears attached units and map objects.

place_unit

Mon, 01 Jan 0001 00:00:00 +0000

Places a live unit at a position on a map.

Function

Synopsis

btech.map.place_unit( unit, map, position )

Arguments

DbRef|Object unit: The live unit.
DbRef|Object map: The destination BattleTech map.
BtechPosition position: The zero-based x and y coordinates and optional z altitude. When provided, z must be an integer from 0 through 10000. When omitted, the unit’s altitude is derived from the destination terrain rather than preserved; drop-surface state is cleared, and flying unit classes are marked as landed.

Returns

None.

range

Mon, 01 Jan 0001 00:00:00 +0000

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.

set_cargo_transfer_point

Mon, 01 Jan 0001 00:00:00 +0000

Sets or clears a map’s cargo-transfer point.

Function

Synopsis

btech.map.set_cargo_transfer_point( map, point )

Arguments

DbRef|Object map: The BattleTech map.
BtechCargoTransferPoint|nil point: The new point, or nil to clear it.

A non-nil point requires these fields:

integer x, integer y: A valid hex on the map.
boolean reveal_hint: Whether to reveal the cargo-transfer hint.

Returns

None.

set_link

Mon, 01 Jan 0001 00:00:00 +0000

Sets or clears a child map’s parent-link configuration.

Function

Synopsis

btech.map.set_link( child, link )

Arguments

DbRef|Object child: The child BattleTech map.
BtechMapLink|nil link: The new parent link, or nil to clear it.

A non-nil link requires these fields:

DbRef|Object parent: The parent BattleTech map. A map cannot be its own parent.
integer x, integer y: A valid destination hex on the parent map.

The link may contain an entrances table with north, east, south, and west fields. Each directional field is optional and uses one of these forms:

terrain

Mon, 01 Jan 0001 00:00:00 +0000

Returns the terrain type of a map hex.

Function

Synopsis

btech.map.terrain( map, hex )

Arguments

DbRef|Object map: The BattleTech map.
BtechHex hex: The zero-based map coordinates.

Returns

BtechTerrain terrain: The canonical terrain name.

unit_by_id

Mon, 01 Jan 0001 00:00:00 +0000

Finds a unit by its tactical ID.

Function

Synopsis

btech.map.unit_by_id( origin, id )

Arguments

DbRef|Object origin: A BattleTech map or a unit on the map.
string id: An exact two-character ASCII tactical ID.

Returns

Object|nil unit: The matching unit, or nil when none exists.

units

Mon, 01 Jan 0001 00:00:00 +0000

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.

update_links

Mon, 01 Jan 0001 00:00:00 +0000

Recursively updates a map and its linked child maps.

Function

Synopsis

btech.map.update_links( map )

Arguments

DbRef|Object map: The root BattleTech map.

Returns

None.

btech.map on StompyMUX Documentation

blast_zones

Function

Synopsis

Arguments

Returns

See Also

cargo_transfer_point

Function

Synopsis

Arguments

Returns

See Also

elevation

Function

Synopsis

Arguments

Returns

See Also

emit

Function

Synopsis

Arguments

Returns

Notes

in_blast_zone

Function

Synopsis

Arguments

Returns

See Also

line_of_sight

Function

Synopsis

Arguments

Returns

See Also

link

Function

Synopsis

Arguments

Returns

See Also

load

Function

Synopsis

Arguments

Returns

Notes

See Also

place_unit

Function

Synopsis

Arguments

Returns

range

Function

Synopsis

Arguments

Returns

Notes

set_cargo_transfer_point

Function

Synopsis

Arguments

Returns

See Also

set_link

Function

Synopsis

Arguments

terrain

Function

Synopsis

Arguments

Returns

See Also

unit_by_id

Function

Synopsis