btech.template on StompyMUX Documentation

armor

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

Returns a template’s armor and internal values.

Function

Synopsis

btech.template.armor( reference, section )

Arguments

string reference: The unit-template reference.
BtechSection|nil section: An optional typed constant from btech.unit.sections that is valid for the template.

Returns

BtechArmorStatus status: The requested armor status.

Notes

When section is omitted, the returned armor, internal-structure, and rear- armor values are totals across all sections, and the record has no section field. When present, the returned section is the same typed constant and can be used with live-unit section functions.

base_cost

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

Calculates a template’s FASA base cost.

Function

Synopsis

btech.template.base_cost( reference )

Arguments

string reference: The unit-template reference.

Returns

integer cost: The base cost.

Notes

The result must not exceed Lua’s maximum safe integer, 9,007,199,254,740,991 (2^53 - 1). A larger calculated cost raises mux.internal.

battle_value

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

Calculates a template’s battle value.

Function

Synopsis

btech.template.battle_value( reference )

Arguments

string reference: The unit-template reference.

Returns

BtechBattleValue value: The total, offensive, and defensive values.

critical_slots

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

Lists a template section’s critical slots.

Function

Synopsis

btech.template.critical_slots( reference, section )

Arguments

string reference: The unit-template reference.
BtechSection section: A typed constant from btech.unit.sections that is valid for the template.

Returns

BtechCriticalSlot[] slots: The critical-slot records. Each record’s section, fire_modes, and ammunition_modes fields contain typed constants from the corresponding btech.unit namespaces and can be reused as live-unit inputs.

engine

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

Returns a template’s engine configuration.

Function

Synopsis

btech.template.engine( reference )

Arguments

string reference: The unit-template reference.

Returns

BtechEngine engine: The rating and suspension factor.

exists

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

Tests whether a unit template exists.

Function

Synopsis

btech.template.exists( reference )

Arguments

string reference: The unit-template reference.

Returns

boolean exists: Whether the template exists.

Notes

An empty reference or one containing .., /, or \ raises mux.arg.invalid. A well-formed missing reference returns false. When the referenced file exists but is not a valid template, the function raises btech.template.invalid.

installed_parts

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

Lists parts installed in a unit template’s non-destroyed critical slots.

Function

Synopsis

btech.template.installed_parts( reference )

Arguments

string reference: The unit-template reference.

Returns

BtechPartStack[] parts: The installed parts and quantities. Parts represented only by critical slots marked with the Destroyed fire mode are omitted.

Notes

Consecutive weapon slots in the same section with the same part and brand are grouped as one weapon installation. Consequently, separate identical one-slot weapons installed in adjacent slots are reported with a combined quantity of one.

payload

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

Lists a template’s weapons and ammunition.

Function

Synopsis

btech.template.payload( reference )

Arguments

string reference: The unit-template reference.

Returns

BtechPartStack[] parts: The payload parts and quantities. Parts represented only by critical slots marked with the Destroyed fire mode are omitted.

Notes

show_critical_status

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

Sends a template’s critical-status report to a player.

Function

Synopsis

btech.template.show_critical_status( reference, player, section )

Arguments

string reference: The unit-template reference.
DbRef|Object player: The report recipient.
BtechSection section: A typed constant from btech.unit.sections that is valid for the template.

Returns

None.

show_status

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

Sends a template’s status report to a player.

Function

Synopsis

btech.template.show_status( reference, player )

Arguments

string reference: The unit-template reference.
DbRef|Object player: The report recipient.

Returns

None.

show_weapon_specs

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

Sends a template’s weapon-specification report to a player.

Function

Synopsis

btech.template.show_weapon_specs( reference, player )

Arguments

string reference: The unit-template reference.
DbRef|Object player: The report recipient.

Returns

None.

technologies

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

Lists a template’s configured and inferred technologies.

Function

Synopsis

btech.template.technologies( reference )

Arguments

string reference: The unit-template reference.

Returns

BtechTechnology[] technologies: The technology records. code is a typed constant from btech.unit.technology, group is one of the literal strings primary, secondary, or infantry, and name remains a human-readable string. Codes can be supplied directly to live-unit technology mutators. The descriptive group is not a btech.unit.technology_groups clear-operation constant.

weapons

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

Lists the weapons mounted on a unit template.

Function

Synopsis

btech.template.weapons( reference, section )

Arguments

string reference: The unit-template reference.
BtechSection|nil section: An optional typed constant from btech.unit.sections that is valid for the template.

Returns

BtechMountedWeapon[] weapons: The mounted weapons. Each section field is a typed BtechSection constant and can be reused with live-unit functions.

btech.template on StompyMUX Documentation

armor

Function

Synopsis

Arguments

Returns

Notes

base_cost

Function

Synopsis

Arguments

Returns

Notes

See Also

battle_value

Function

Synopsis

Arguments

Returns

See Also

critical_slots

Function

Synopsis

Arguments

Returns

See Also

engine

Function

Synopsis

Arguments

Returns

See Also

exists

Function

Synopsis

Arguments

Returns

Notes

See Also

installed_parts

Function

Synopsis

Arguments

Returns

Notes

payload

Function

Synopsis

Arguments

Returns

Notes

show_critical_status

Function

Synopsis

Arguments

Returns

See Also

show_status

Function

Synopsis

Arguments

Returns

See Also

show_weapon_specs

Function

Synopsis

Arguments

Returns

See Also

technologies

Function

Synopsis

Arguments

Returns

See Also

weapons

Function

Synopsis

Arguments

Returns