btech.repair on StompyMUX Documentation

apply

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

Performs an immediate repair on a live unit.

Function

Synopsis

btech.repair.apply( unit, repair )

Arguments

DbRef|Object unit

A registered live BattleTech unit.

table repair

A strict operation record. Unknown fields are rejected. Every record requires a typed BtechSection in section and one of these exact shapes, using btech.repair.operations:

{ operation = operations.REPAIR_ARMOR, section = BtechSection, value = integer }
{ operation = operations.REPAIR_INTERNAL, section = BtechSection, value = integer }
{ operation = operations.REPAIR_REAR_ARMOR, section = BtechSection, value = integer }
{ operation = operations.REPAIR_PART, section = BtechSection, slot = integer }
{ operation = operations.REATTACH, section = BtechSection }

Raw operation and section strings are rejected. Armor and internal values must be integers from 0 through 255. slot is a one-based integer within the selected section’s current critical-slot count. REPAIR_REAR_ARMOR is valid only for a Mech’s center, left, or right torso (CTORSO/CT, LTORSO/LT, or RTORSO/RT); this immediate operation is rejected for every other section and unit type.

btech.repair.operations

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

btech.repair.operations is an immutable namespace of typed BtechRepairOperation constants.

Function

Synopsis

btech.repair.operations.CONSTANT

Arguments

This namespace takes no arguments.

Returns

BtechRepairOperation constant: The typed operation represented by CONSTANT.

Raises

Raises mux.arg.invalid for invalid lookup, mutation, raw strings, wrong-kind constants, or constants from another runtime.

Notes

Constants belong to their namespace and the Lua runtime that created them.

Constants
`REATTACH`, `REPAIR_PART`, `REPAIR_WEAPON_TEMPORARY`, `REPAIR_ENHANCEMENT`, `REPAIR_FOCUS`, `REPAIR_CRYSTAL`, `REPAIR_BARREL`, `REPAIR_AMMO_FEED`, `REPAIR_RANGING`, `REPAIR_AMMO_MOUNT`, `REPLACE_WEAPON`, `RELOAD`, `REPAIR_ARMOR`, `REPAIR_REAR_ARMOR`, `REPAIR_INTERNAL`, `DETACH`, `SCRAP_PART`, `SCRAP_WEAPON`, `UNLOAD`, `RESEAL`, `REPLACE_SUIT`

btech.repair.apply accepts the supported immediate-repair subset: REATTACH, REPAIR_PART, REPAIR_ARMOR, REPAIR_REAR_ARMOR, and REPAIR_INTERNAL. Other constants describe jobs returned by btech.repair.needs and are rejected by apply.

is_fixable

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

Tests whether a live unit can be repaired.

Function

Synopsis

btech.repair.is_fixable( unit )

Arguments

DbRef|Object unit: The live unit.

Returns

boolean fixable: Whether the unit is fixable.

is_under_repair

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

Tests whether a live unit has an active repair event.

Function

Synopsis

btech.repair.is_under_repair( unit )

Arguments

DbRef|Object unit: The live unit.

Returns

boolean under_repair: Whether the unit is under repair.

needs

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

Lists the repairs needed by a live unit.

Function

Synopsis

btech.repair.needs( unit )

Arguments

DbRef|Object unit: The live unit.

Returns

BtechRepairNeed[] needs: The required and in-progress repair operations. Each operation is a typed BtechRepairOperation constant and each section is a typed BtechSection constant; both round-trip into btech.repair.apply for supported immediate repairs.

Notes

Scheduled repair discovery preserves compatibility with stored unit data. It may report rear-armor jobs for any section whose configured current and original rear values differ. Scheduled technician work can restore configured stored rear armor for ordinary deficits where the current value is below the original value. Outside a Mech’s center, left, and right torsos, stored rear armor is not consumed by combat and cannot be changed through the immediate btech.repair.apply operation.

technician_available_in

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

Returns the time until a player’s technician is available.

Function

Synopsis

btech.repair.technician_available_in( player )

Arguments

DbRef|Object player: The player.

Returns

integer seconds: The remaining wait in seconds.

btech.repair on StompyMUX Documentation

apply

Function

Synopsis

Arguments

btech.repair.operations

Function

Synopsis

Arguments

Returns

Raises

Notes

is_fixable

Function

Synopsis

Arguments

Returns

See Also

is_under_repair

Function

Synopsis

Arguments

Returns

See Also

needs

Function

Synopsis

Arguments

Returns

Notes

technician_available_in

Function

Synopsis

Arguments

Returns

See Also