btech.player on StompyMUX Documentation

loadout

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

Returns a player’s personal-combat loadout.

Function

Synopsis

btech.player.loadout( player )

Arguments

DbRef|Object player: The player.

Returns

BtechPersonalCombatLoadout|nil loadout: The loadout, or nil when unset.

mechwarrior_template

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

Returns a player’s ejected-pilot template override.

Function

Synopsis

btech.player.mechwarrior_template( player )

Arguments

DbRef|Object player: The player.

Returns

string|nil reference: The template reference, or nil when unset.

set_loadout

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

Sets or clears a player’s personal-combat loadout.

Function

Synopsis

btech.player.set_loadout( player, loadout )

Arguments

DbRef|Object player: The player.
BtechPersonalCombatLoadout|nil loadout: The new loadout, or nil to clear it.

A loadout contains a required armor table:

Field	Type	Range
`head`	integer	0 to 2
`torso`	integer	0 to 8
`hands`	integer	0 to 2
`feet`	integer	0 to 2

It may also contain right and left equipment tables. Each equipment table has these fields:

set_mechwarrior_template

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

Sets or clears a player’s ejected-pilot template override.

Function

Synopsis

btech.player.set_mechwarrior_template( player, reference )

Arguments

DbRef|Object player: The player.
string|nil reference: A non-empty resource name of at most 24 bytes that identifies an existing, well-formed unit template, or nil to clear the override. A non-nil reference cannot contain .., /, or \.

Returns

None.

Notes

A missing template raises btech.template.not_found. A template that exists but is malformed raises btech.template.invalid; invalid reference syntax raises mux.arg.invalid.

set_ui_preferences

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

Sets or clears a player’s map-display preferences.

Function

Synopsis

btech.player.set_ui_preferences( player, preferences )

Arguments

DbRef|Object player: The player.
BtechUiPreferencesState|nil preferences: The new preferences, or nil to clear them and restore the defaults.

Returns

None.

Example

btech.player.set_ui_preferences(player, {
 tactical_height = 14, tactical_width = 21, lrs_height = 11,
 include_dead = false, include_shutdown = true,
 include_enemies = true, include_allies = true, include_target = true,
 buildings = "exclude",
})

Notes

Heights must be 5–24 for tactical, 5–40 for tactical width, and 10–40 for LRS. A table returned by ui_preferences can be passed directly; its informational configured field is ignored.

ui_preferences

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

Returns a player’s effective map-display preferences.

Function

Synopsis

btech.player.ui_preferences( player )

Arguments

DbRef|Object player: The player.

Returns

BtechUiPreferencesState preferences: The effective preferences and configured state.

Example

local preferences = btech.player.ui_preferences(player)
if preferences.configured then
 -- The player has explicitly configured these values.
end

Notes

The table contains tactical_height, tactical_width, lrs_height, the five include_* booleans, buildings (follow_brief, include, or exclude), and the configured boolean.

btech.player on StompyMUX Documentation

loadout

Function

Synopsis

Arguments

Returns

See Also

mechwarrior_template

Function

Synopsis

Arguments

Returns

See Also

set_loadout

Function

Synopsis

Arguments

set_mechwarrior_template

Function

Synopsis

Arguments

Returns

Notes

set_ui_preferences

Function

Synopsis

Arguments

Returns

Example

Notes

ui_preferences

Function

Synopsis

Arguments

Returns

Example

Notes

See Also