btech package on StompyMUX Documentation

btech.add_stores

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

Adds a quantity of a part to an object’s stores.

Function

Synopsis

btech.add_stores( target, part_name, quantity )

Arguments

number target: The dbref of the stores-bearing object.
string part_name: A recognized part name.
number quantity: The quantity to add, capped by the server limit.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The underlying quantity is capped at the server’s per-call maximum. A part name that does not match returns the legacy false result, but mutation-result normalization still returns true; callers should resolve user input with btech.part_match before mutating stores.

btech.armor_status

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

Returns serialized armor values for one section of a live unit.

Function

Synopsis

btech.armor_status( unit, section )

Arguments

number unit: The unit dbref.
string section: The section name.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.armor_status_ref

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

Returns serialized armor values for one section of a unit template.

Function

Synopsis

btech.armor_status_ref( reference, section )

Arguments

string reference: The unit template reference.
string section: The section name.

Returns

string result: The handler’s serialized text result.

Notes

btech.battle_value

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

Calculates the battle value of a live unit.

Function

Synopsis

btech.battle_value( unit )

Arguments

number unit: The unit dbref.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.battle_value_ref

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

Calculates the battle value of a unit template.

Function

Synopsis

btech.battle_value_ref( reference )

Arguments

string reference: The unit template reference.

Returns

number value: The numeric result.

Notes

btech.battle_value2_ref

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

Calculates the second-generation battle value of a unit template.

Function

Synopsis

btech.battle_value2_ref( reference )

Arguments

string reference: The unit template reference.

Returns

number value: The numeric result.

Notes

btech.blast_zones

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

Lists blast-zone coordinates and radii on a map.

Function

Synopsis

btech.blast_zones( map )

Arguments

number map: The map dbref.

Returns

table values: A flat array of repeating x, y, and radius numbers.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.char_list

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

Lists character value names in a requested category.

Function

Synopsis

btech.char_list( kind, [character] )

Arguments

string kind: "skills", "advantages", or "attributes".
number or string character: Optional character dbref or player name used to filter learned values.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.char_value

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

Gets a character attribute, skill level, target, experience, or experience threshold.

Function

Synopsis

btech.char_value( character, value, mode )

Arguments

number or string character: The character dbref or player name.
number or string value: The character-value code or name.
number mode: 0 for value, 1 for skill target, 2 for XP, 3 for raw skill value, or 4 for XP to next level.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.crit_slot

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

Describes one critical slot on a live unit.

Function

Synopsis

btech.crit_slot( unit, section, slot, [name_type] )

Arguments

number unit: The unit dbref.
string section: The section name.
number slot: The critical-slot number.
number name_type: Optional naming mode: 0 for template names or 1 for repair-part names.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.crit_slot_ref

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

Describes one critical slot in a unit template.

Function

Synopsis

btech.crit_slot_ref( reference, section, slot, [name_type] )

Arguments

string reference: The unit template reference.
string section: The section name.
number slot: The critical-slot number.
number name_type: Optional naming mode: 0 for template names or 1 for repair-part names.

Returns

string result: The handler’s serialized text result.

Notes

btech.crit_status

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

Returns serialized critical-slot status for one section of a live unit.

Function

Synopsis

btech.crit_status( unit, section )

Arguments

number unit: The unit dbref.
string section: The section name.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.crit_status_ref

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

Returns serialized critical-slot status for one section of a unit template.

Function

Synopsis

btech.crit_status_ref( reference, section )

Arguments

string reference: The unit template reference.
string section: The section name.

Returns

string result: The handler’s serialized text result.

Notes

btech.damage_mech

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

Applies clustered damage to a live unit.

Function

Synopsis

btech.damage_mech( unit, damage, cluster_size, direction, force_critical, unit_message, los_message )

Arguments

number unit: The unit dbref.
number damage: Total damage, from 1 through 1000.
number cluster_size: Damage applied per cluster; at least 1.
number direction: The attack direction code.
boolean or number force_critical: Whether to try to force a critical hit.
string unit_message: Message sent to the damaged unit.
string los_message: Message broadcast to units with line of sight.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.damages

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

Returns the formatted repair-job description for a live unit.

Function

Synopsis

btech.damages( unit )

Arguments

number unit: The unit dbref.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.defensive_battle_value_ref

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

Calculates the defensive battle-value component of a unit template.

Function

Synopsis

btech.defensive_battle_value_ref( reference )

Arguments

string reference: The unit template reference.

Returns

number value: The numeric result.

Notes

btech.design_exists

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

Tests whether a unit template exists.

Function

Synopsis

btech.design_exists( reference )

Arguments

string reference: The unit template reference.

Returns

boolean result: Whether the condition is true.

Examples

local btech = require("btech")

if btech.design_exists("AS7-D") then
 mux.notify(ctx.enactor, "The design is available.")
end

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.engine_rating

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

Returns the engine rating of a live unit.

Function

Synopsis

btech.engine_rating( unit )

Arguments

number unit: The unit dbref.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The legacy handler also emits a suspension factor after the rating; numeric conversion returns only the leading engine rating.

btech.engine_rating_ref

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

Returns the engine rating of a unit template.

Function

Synopsis

btech.engine_rating_ref( reference )

Arguments

string reference: The unit template reference.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The reference is resolved from the configured unit-template database. The legacy handler also emits a suspension factor after the rating; numeric conversion returns only the leading engine rating.

btech.fasa_base_cost_ref

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

Calculates the FASA base cost of a unit template.

Function

Synopsis

btech.fasa_base_cost_ref( reference )

Arguments

string reference: The unit template reference.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The reference is resolved from the configured unit-template database. This operation requires a build with advanced economy support.

btech.get_weight

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

Returns a part’s weight in tons.

Function

Synopsis

btech.get_weight( part_name )

Arguments

string part_name: A recognized long or very-long part name.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.hex_emit

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

Broadcasts a message from one map hex.

Function

Synopsis

btech.hex_emit( map, x, y, message )

Arguments

number map: The map dbref.
number x: The hex X coordinate.
number y: The hex Y coordinate.
string message: A non-empty message.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.hex_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.hex_in_blast_zone( map, x, y )

Arguments

number map: The map dbref.
number x: The hex X coordinate.
number y: The hex Y coordinate.

Returns

boolean result: Whether the condition is true.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.hex_line_of_sight

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

Tests whether a live unit has unobstructed line of sight to a map hex.

Function

Synopsis

btech.hex_line_of_sight( unit, x, y )

Arguments

number unit: The observing unit dbref.
number x: The target hex X coordinate.
number y: The target hex Y coordinate.

Returns

boolean result: Whether the condition is true.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.id_to_dbref

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

Resolves a two-character tactical ID on a unit’s map.

Function

Synopsis

btech.id_to_dbref( unit_or_map, id )

Arguments

number unit_or_map: The observing unit or map dbref.
string id: The two-character tactical ID.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The legacy handler formats a successful dbref with a leading #; the numeric Lua adapter currently converts that format to 0.

btech.lag

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

Returns the current BattleTech event lag.

Function

Synopsis

btech.lag( )

Arguments

None.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.load_map

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

Loads a map file into a map object and clears its units and map objects.

Function

Synopsis

btech.load_map( map, name, [clear] )

Arguments

number map: The map-object dbref.
string name: The map file name.
boolean clear: Optional compatibility argument; currently ignored.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The optional clear argument is retained for compatibility; the current handler always clears units and map objects.

btech.load_mech

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

Loads a unit template into a live unit object.

Function

Synopsis

btech.load_mech( unit, reference )

Arguments

number unit: The unit dbref.
string reference: The unit template reference.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.make_pilot_roll

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

Makes a piloting roll and causes a fall when it fails.

Function

Synopsis

btech.make_pilot_roll( unit, roll_modifier, damage_modifier )

Arguments

number unit: The unit dbref.
number roll_modifier: Modifier applied to the piloting roll.
number damage_modifier: Modifier passed to falling damage.

Returns

boolean result: Whether the condition is true.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.map_elevation

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

Returns the elevation of a map hex.

Function

Synopsis

btech.map_elevation( map, x, y )

Arguments

number map: The map dbref.
number x: The hex X coordinate.
number y: The hex Y coordinate.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.map_emit

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

Broadcasts a message to all or nearby units on a map.

Function

Broadcasts to every unit on a map.

Synopsis

btech.map_emit( map, message )

Arguments

number map: The map dbref.
string message: A non-empty message.

Returns

boolean success: true after the operation completes without a legacy error.

Function

Broadcasts to units within a two-dimensional range of a map coordinate.

Synopsis

btech.map_emit( map, x, y, range, message )

Arguments

number map: The map dbref.
number x, y: The origin hex coordinates.
number range: A non-negative range.
string message: A non-empty message.

Returns

boolean success: true after the operation completes without a legacy error.

Function

Broadcasts to units within a three-dimensional range of a map coordinate.

btech.map_terrain

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

Returns the terrain code of a map hex.

Function

Synopsis

btech.map_terrain( map, x, y )

Arguments

number map: The map dbref.
number x: The hex X coordinate.
number y: The hex Y coordinate.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.map_units

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

Lists all units on a map or those within a 2D or 3D range.

Function

Lists every live unit on a map.

Synopsis

btech.map_units( map )

Arguments

number map: The map dbref.

Returns

table units: An array of unit dbrefs.

Function

Lists units within a two-dimensional range of a map coordinate.

Synopsis

btech.map_units( map, x, y, range )

Arguments

number map: The map dbref.
number x, y: The origin hex coordinates.
number range: A non-negative range.

Returns

table units: An array of unit dbrefs.

Function

Lists units within a three-dimensional range of a map coordinate.

btech.mech_frequencies

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

Lists the configured radio channels of a live unit.

Function

Synopsis

btech.mech_frequencies( unit )

Arguments

number unit: The unit dbref.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The flattened array reflects the legacy channel serialization rather than structured channel records.

btech.mech_line_of_sight

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

Tests line of sight between two live units.

Function

Synopsis

btech.mech_line_of_sight( unit, target )

Arguments

number unit: The observing unit dbref.
number target: The target unit dbref.

Returns

boolean visible: true when the legacy line-of-sight result is nonzero.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The underlying handler distinguishes clear line of sight (1) from blocked line of sight (2), but the boolean Lua conversion maps both nonzero results to true.

btech.offensive_battle_value_ref

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

Calculates the offensive battle-value component of a unit template.

Function

Synopsis

btech.offensive_battle_value_ref( reference )

Arguments

string reference: The unit template reference.

Returns

number value: The numeric result.

Notes

btech.part_categories

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

Lists the canonical categories accepted by btech.parts.

Function

Synopsis

btech.part_categories( )

Arguments

None.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.part_cost

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

Returns the configured cost of a part.

Function

Synopsis

btech.part_cost( part_name )

Arguments

string part_name: A recognized long or very-long part name.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. This operation requires a build with advanced economy support.

btech.part_match

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

Finds packed part IDs whose names match a string.

Function

Synopsis

btech.part_match( query )

Arguments

string query: The part-name text to match.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.part_name

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

Returns a name for a packed part ID.

Function

Synopsis

btech.part_name( part, size )

Arguments

number part: The packed part ID.
string size: "short", "long", or "vlong".

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.part_type

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

Returns the broad category of a part.

Function

Synopsis

btech.part_type( part_name )

Arguments

string part_name: A recognized long or very-long part name.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.part_weight

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

Returns a part’s weight in tons.

Function

Synopsis

btech.part_weight( part_name )

Arguments

string part_name: A recognized long or very-long part name.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.parts

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

Lists canonical long part names in one category.

Function

Synopsis

btech.parts( category )

Arguments

string category: "ammo", "weapon", "bomb", "special", or "cargo". The aliases "weapons", "weap", "bombs", "specials", "part", "parts", and "carg" are also accepted.

Returns

table values: A flat array of converted legacy result tokens.

Examples

local btech = require("btech")

for _, name in ipairs(btech.parts("weapon")) do
 mux.notify(ctx.enactor, name)
end

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.payload_ref

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

Returns the weapon and ammunition payload of a unit template.

Function

Synopsis

btech.payload_ref( reference )

Arguments

string reference: The unit template reference.

Returns

string result: The handler’s serialized text result.

Notes

btech.range

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

Calculates distance between units or map coordinates.

Function

Calculates the range between two live units on the map.

Synopsis

btech.range( map, unit_a, unit_b )

Arguments

number map: The map dbref.
number unit_a: The first unit dbref.
number unit_b: The second unit dbref.

Returns

number range: The three-dimensional range between the units.

Function

Calculates the range between a live unit and a map hex, using the hex’s elevation.

Synopsis

btech.range( map, unit, x, y )
btech.range( map, x, y, unit )

Arguments

number map: The map dbref.
number unit: A unit dbref on the map.
number x: The hex X coordinate.
number y: The hex Y coordinate.

Returns

number range: The three-dimensional range from the unit to the hex.

Function

Calculates the range between a live unit and a coordinate with an explicit altitude.

btech.real_max_speed

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

Returns a live unit’s effective maximum speed.

Function

Synopsis

btech.real_max_speed( unit )

Arguments

number unit: The unit dbref.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.remove_stores

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

Removes a quantity of a part from an object’s stores.

Function

Synopsis

btech.remove_stores( target, part_name, quantity )

Arguments

number target: The stores-bearing object dbref.
string part_name: A recognized part name.
number quantity: The quantity to remove.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.repair_job_count

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

Returns the number of pending repair jobs on a live unit.

Function

Synopsis

btech.repair_job_count( unit )

Arguments

number unit: The unit dbref.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.section_status

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

Returns serialized status for one section of a live unit.

Function

Synopsis

btech.section_status( unit, section )

Arguments

number unit: The unit dbref.
string section: The section name.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.set_armor_status

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

Sets one armor-status field on a live unit section.

Function

Synopsis

btech.set_armor_status( unit, section, field, value )

Arguments

number unit: The unit dbref.
string section: The section name.
string field: The armor field to change.
number value: The new value.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.set_char_value

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

Sets a character value or adjusts skill experience.

Function

Synopsis

btech.set_char_value( character, value, amount, mode )

Arguments

number or string character: The character dbref or player name.
number or string value: The character-value code or name.
number amount: The value or experience amount.
number mode: 0 sets level/value, 1 sets skill target, 3 sets XP, and other nonzero values add XP.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.set_max_speed

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

Sets a live unit’s maximum speed and corrects its current speed.

Function

Synopsis

btech.set_max_speed( unit, speed )

Arguments

number unit: The unit dbref.
number speed: The new maximum speed.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.set_part_cost

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

Sets the configured cost of a part.

Function

Synopsis

btech.set_part_cost( part_name, cost )

Arguments

string part_name: A recognized long or very-long part name.
number cost: The non-negative cost.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

btech.set_tons

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

Sets a live unit’s tonnage and original weight.

Function

Synopsis

btech.set_tons( unit, tons )

Arguments

number unit: The unit dbref.
number tons: The new tonnage.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.set_xcode_value

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

Writes a script-writable native field on a live special object.

Function

Synopsis

btech.set_xcode_value( object, name, value )

Arguments

number object: The special-object dbref.
string name: The writable field name.
string or number value: The new value, converted according to the field type.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.set_xy

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

Places a live unit on a map at specified coordinates.

Function

Synopsis

btech.set_xy( unit, map, x, y, [z] )

Arguments

number unit: The unit dbref.
number map: The destination map dbref.
number x: The destination X coordinate.
number y: The destination Y coordinate.
number z: Optional altitude, defaulting to 0.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.show_crit_status_ref

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

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

Function

Synopsis

btech.show_crit_status_ref( reference, player, section )

Arguments

string reference: The unit template reference.
number player: The recipient player dbref.
string section: The section passed to the critical-status renderer.

Returns

string result: The handler’s serialized text result.

Notes

btech.show_status_ref

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

Sends a unit template’s status display to a player.

Function

Synopsis

btech.show_status_ref( reference, player )

Arguments

string reference: The unit template reference.
number player: The recipient player dbref.

Returns

string result: The handler’s serialized text result.

Notes

btech.show_weapon_specs_ref

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

Sends a unit template’s weapon-specification display to a player.

Function

Synopsis

btech.show_weapon_specs_ref( reference, player )

Arguments

string reference: The unit template reference.
number player: The recipient player dbref.

Returns

string result: The handler’s serialized text result.

Notes

btech.stores

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

Returns a part quantity or lists an object’s stored parts.

Function

Synopsis

btech.stores( target, part_name )

Arguments

number target: The stores-bearing object dbref.
string part_name: A recognized part name.

Returns

table result: A one-element array containing the numeric quantity.

Function

Lists every nonempty part stack on the object.

Synopsis

btech.stores( target )

Arguments

number target: The stores-bearing object dbref.

Returns

table stores: A flat array of serialized name:quantity strings.

Examples

local btech = require("btech")
local quantity = btech.stores(bay_dbref, "IS.AC/10")[1]

mux.notify(ctx.enactor, "Available: " .. quantity)

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.stores_short

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

Returns a part quantity or lists stored parts using short names.

Function

Synopsis

btech.stores_short( target, part_name )

Arguments

number target: The stores-bearing object dbref.
string part_name: A recognized part name.

Returns

table result: A one-element array containing the numeric quantity.

Function

Lists every nonempty part stack using short part names.

Synopsis

btech.stores_short( target )

Arguments

number target: The stores-bearing object dbref.

Returns

table stores: A flat array of serialized name:quantity strings using short part names.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.tech_list

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

Lists the parts needed to repair a live unit.

Function

Synopsis

btech.tech_list( unit )

Arguments

number unit: The unit dbref.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.tech_list_ref

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

Lists the parts needed to repair a unit template.

Function

Synopsis

btech.tech_list_ref( reference )

Arguments

string reference: The unit template reference.

Returns

table values: A flat array of converted legacy result tokens.

Notes

btech.tech_status

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

Returns formatted repair status for a live unit.

Function

Synopsis

btech.tech_status( unit )

Arguments

number unit: The unit dbref.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.tech_time

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

Runs the legacy technician-time query.

Function

Synopsis

btech.tech_time( )

Arguments

None.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. The legacy handler sends a formatted time directly to its invocation player and does not write a return value; through the Lua adapter the numeric result is therefore 0.

btech.threshold

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

Returns the configured experience threshold for a skill.

Function

Synopsis

btech.threshold( skill )

Arguments

string skill: The skill name.

Returns

number value: The numeric result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.tic_weapons

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

Lists the weapons assigned to a unit’s target-interlock circuit.

Function

Synopsis

btech.tic_weapons( unit, tic )

Arguments

number unit: The unit dbref.
number tic: The zero-based TIC number.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.under_repair

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

Tests whether a live unit has an active repair event.

Function

Synopsis

btech.under_repair( unit )

Arguments

number unit: The unit dbref.

Returns

boolean result: Whether the condition is true.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.unit_fixable

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

Tests whether a live unit can be repaired.

Function

Synopsis

btech.unit_fixable( unit )

Arguments

number unit: The unit dbref.

Returns

boolean result: Whether the condition is true.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.unit_parts

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

Lists the parts installed on a live unit.

Function

Synopsis

btech.unit_parts( unit )

Arguments

number unit: The unit dbref.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.unit_parts_ref

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

Lists the parts installed in a unit template.

Function

Synopsis

btech.unit_parts_ref( reference )

Arguments

string reference: The unit template reference.

Returns

table values: A flat array of converted legacy result tokens.

Notes

btech.update_links

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

Recursively updates links associated with a map.

Function

Synopsis

btech.update_links( map )

Arguments

number map: The map dbref.

Returns

boolean success: true after the operation completes without a legacy error.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.weapon_stat

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

Returns one numeric weapon-catalog statistic as text.

Function

Synopsis

btech.weapon_stat( weapon, stat )

Arguments

string weapon: A recognized weapon part name.
string stat: One of VRT, TYPE, HEAT, DAMAGE, MIN, SR, MR, LR, CRIT, AMMO, WEIGHT, or BV.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error. Although the selected statistic is numeric, this binding is registered as a text result.

btech.weapon_status

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

Returns serialized weapon status for a live unit or one section.

Function

Synopsis

btech.weapon_status( unit, [section] )

Arguments

number unit: The unit dbref.
string section: Optional section name.

Returns

string result: The handler’s serialized text result.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.weapon_status_ref

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

Returns serialized weapon status for a unit template or one section.

Function

Synopsis

btech.weapon_status_ref( reference, [section] )

Arguments

string reference: The unit template reference.
string section: Optional section name.

Returns

string result: The handler’s serialized text result.

Notes

btech.xcode_value

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

Reads a script-visible native field from a live special object.

Function

Synopsis

btech.xcode_value( object, name )

Arguments

number object: The special-object dbref.
string name: The field name.

Returns

string result: The handler’s serialized text result.

Examples

local btech = require("btech")
local unit_id = btech.xcode_value(unit_dbref, "id")

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech.xcode_value_ref

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

Reads a script-visible native field from a unit template.

Function

Synopsis

btech.xcode_value_ref( reference, name )

Arguments

string reference: The unit template reference.
string name: The field name.

Returns

string result: The handler’s serialized text result.

Notes

btech.zone_mechs

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

Lists live unit objects assigned to a zone.

Function

Synopsis

btech.zone_mechs( zone )

Arguments

number zone: The zone dbref.

Returns

table values: A flat array of converted legacy result tokens.

Notes

This function is available only in a running Lua callback. Invalid targets, invalid arguments, and legacy error results raise a Lua error.

btech package on StompyMUX Documentation

btech.add_stores

Function

Synopsis

Arguments

Returns

Notes

btech.armor_status

Function

Synopsis

Arguments

Returns

Notes

See Also

btech.armor_status_ref

Function

Synopsis

Arguments

Returns

Notes

See Also

btech.battle_value

Function

Synopsis

Arguments

Returns

Notes

See Also

btech.battle_value_ref

Function

Synopsis

Arguments

Returns

Notes

See Also

btech.battle_value2_ref

Function

Synopsis

Arguments

Returns

Notes

See Also

btech.blast_zones

Function

Synopsis

Arguments

Returns

Notes

See Also

btech.char_list

Function

Synopsis

Arguments

Returns

Notes

btech.char_value

Function

Synopsis

Arguments

Returns

Notes

btech.crit_slot

Function

Synopsis

Arguments

Returns

Notes

btech.crit_slot_ref

Function

Synopsis

Arguments

Returns

Notes

btech.crit_status

Function

Synopsis

Arguments

Returns

Notes

See Also