mecha

WELCOME TO MECHA.DM, ENJOY YOUR STAY

Mechs are now (finally) vehicles, this means you can make them multicrew They can also grant select ability buttons based on occupant bitflags

Movement is handled through vehicle_move() which is called by relaymove Clicking is done by way of signals registering to the entering mob NOTE: MMIS are NOT mobs but instead contain a brain that is, so you need special checks AI also has special checks becaus it gets in and out of the mech differently Always call remove_occupant(mob) when leaving the mech so the mob is removed properly

For multi-crew, you need to set how the occupants receive ability bitflags corresponding to their status on the vehicle(i.e: driver, gunner etc) Abilities can then be set to only apply for certain bitflags and are assigned as such automatically

Clicks are wither translated into mech_melee_attack (see mech_melee_attack.dm) Or are used to call action() on equipped gear Cooldown for gear is on the mech because exploits

Vars
accesses	A list of all granted accesses
active_thrusters	/Action vars Ref to any active thrusters we might have
allow_diagonal_movement	Whether this mech is allowed to move diagonally
bumpsmash	Whether or not the mech destroys walls by running into it.
cabin_air	Internal air mix datum
cabin_sealed	////////ATMOS Whether the cabin exchanges gases with the environment
cabin_volume	Volume of the cabin
can_use_overclock	Whether it is possible to toggle overclocking from the cabin
capacitor	Keeps track of the mech's capacitor
cell	Keeps track of the mech's cell
chassis_camera	Camera installed into the mech
completely_disabled	Just stop the mech from doing anything
component_damage_threshold	damage threshold above which we take component damage
defense_mode	Bool for energy shield on/off
destruction_sleep_duration	Time you get slept for if you get forcible ejected by the mech exploding
dna_lock	Stores the DNA enzymes of a carbon so tht only they can access the mech
equip_by_category	assoc list: key-typepathlist before init, key-equipmentlist after
equipment_disabled	if we cant use our equipment(such as due to EMP)
exit_delay	TIme taken to leave the mech
facing_modifiers	Modifiers for directional damage reduction
flat_equipment	flat equipment for iteration
internal_damage	Bitflags for internal damage
internal_damage_probability	% chance for internal damage to occur
internal_damage_threshold	damage amount above which we can take internal damages
is_currently_ejecting	Currently ejecting, and unable to do things
lavaland_only	Bool for whether this mech can only be used on lavaland
light_power_drain	Power we use to have the lights on
lights_power	How powerful our lights are
max_equip_by_category	assoc list: max equips for modules key-count
mech_type	single flag for the type of this mech, determines what kind of equipment can be attached to it
mecha_flags	Contains flags for the mecha
melee_cooldown	Cooldown duration between melee punches
melee_energy_drain	How much energy we drain each time we mechpunch someone
one_access	If the mech should require ALL or only ONE of the listed accesses
ore_box	Handles an internal ore box for mining mechs
overclock_coeff	Speed and energy usage modifier for leg overload
overclock_mode	Bool for leg overload on/off
overclock_safety	Whether the overclocking turns off automatically when overheated
overclock_safety_available	Whether the mech has an option to enable safe overclocking
overclock_temp	Current leg actuator temperature. Increases when overloaded, decreases when not.
overclock_temp_danger	Temperature threshold at which actuators may start causing internal damage
phase_state	icon_state for flick() when phazing
phasing	check for phasing, if it is set to text (to describe how it is phasing: "flying", "phasing") it will let the mech walk through walls.
phasing_energy_drain	Power we use every time we phaze through something
pivot_step	Whether this mech moves into a direct as soon as it goes to move. Basically, turn and step in the same key press.
possible_int_damage	list of possibly dealt internal damage for this mech type
scanmod	Keeps track of the mech's scanning module
servo	Keeps track of the mech's servo motor
silicon_icon_state	In case theres a different iconstate for AI/MMI pilot(currently only used for ripley)
smashcooldown	Cooldown length between bumpsmashes
smoke_charges	Remaining smoke charges
smoke_cooldown	Cooldown between using smoke
spark_system	Spark effects are handled by this datum
step_energy_drain	How much energy the mech will consume each time it moves. this is the current active energy consumed
step_silent	Whether our steps are silent due to no gravity
stepsound	Sound played when the mech moves
strafe	Wether we are strafing
trackers	List of installed remote tracking beacons, including AI control beacons
turnsound	Sound played when the mech walks
ui_selected_module_index	Module selected by default when mech UI is opened
ui_theme	Theme of the mech TGUI
ui_view	ref to screen object that displays in the middle of the UI
updating	Portable camera camerachunk update
weapons_safety	Safety for weapons. Won't fire if enabled, and toggled by middle click.
wreckage	Typepath for the wreckage it spawns when destroyed
Procs
ai_enter_mech	Hack and From Card interactions share some code, so leave that here for both to use.
collect_ore	Collects ore when we move, if there is an orebox and it is functional
diag_hud_set_camera	Shows inbuilt camera on the mech; if the camera's view range was affected by an EMP, shows a red blip while it's affected
diag_hud_set_mechtracking	Shows tracking beacons on the mech
display_speech_bubble	Displays a special speech bubble when someone inside the mecha speaks
do_camera_update	The actual update - also passes our unique update buffer. This makes our static update faster than stationary cameras, helping us to avoid running out of the camera's FoV. An EMPd mecha with a lowered view_range on its camera can still sometimes run out into static before updating, however.
generate_action_type	MECHA ACTIONS
get_armour_facing	returns a number for the damage multiplier for this relative angle/dir
get_int_repair_fluff_end	gets the successful finish balloon alert flufftext
get_int_repair_fluff_fail	gets the on-fail balloon alert flufftext
get_int_repair_fluff_start	gets the starting balloon alert flufftext
get_internal_tank	Locate an internal tack in the utility modules
has_charge	Power stuff
max_ammo	// Ammo stuff /////
mmi_move_inside	proc called when a new mmi mob tries to enter this mech
mmi_moved_inside	proc called when a new mmi mob enters this mech
moved_inside	proc called when a new non-mmi mob enters this mech
on_click_alt	Driver alt clicks anything while in mech
on_light_eater	Special light eater handling
on_middlemouseclick	middle mouse click signal wrapper for AI users
on_mouseclick	Called when a driver clicks somewhere. Handles everything like equipment, punches, etc.
on_move	Called when the mech moves
on_turn	Called when the driver turns with the movement lock key
play_stepsound	Plays the mech step sound effect. Split from movement procs so that other mechs (HONK) can override this one specific part.
populate_parts	If the former occupants get polymorphed, mutated, chestburstered, or otherwise replaced by another mob, that mob is no longer in .occupants and gets deleted with the mech. However, they do remain in .contents Add parts on mech spawning. Skipped in manual construction.
remove_air	Atmospheric stuff
return_pressure	fetches pressure of the gas mixture we are using
return_temperature	fetches temp of the gas mixture we are using
setDir	Sets the direction of the mecha and all of its occcupents, required for FOV. Alternatively one could make a recursive contents registration and register topmost direction changes in the fov component
set_cabin_seal	makes cabin unsealed, dumping cabin air outside or airtight filling the cabin with external air mix
set_mouse_pointer	Updates the pilot's mouse cursor override.
set_safety	Toggles Weapons Safety
shock	Electrocute user from power celll
toggle_lights	Toggle lights on/off
toggle_overclock	Toggle mech overclock with a button or by hacking
try_damage_component	tries to damage mech equipment depending on damage and where is being targeted
try_deal_internal_damage	tries to deal internal damaget depending on the damage amount
try_insert_part	Try to insert a stock part into the mech
try_repair_int_damage	tries to repair any internal damage and plays fluff for it
update_access	Apply corresponding accesses
update_energy_drain	Update the energy drain according to parts and status
upgrade_rcd	list of materials contained in the ammo box after we put it through the equation so we can stick this list into set_custom_materials() Upgrades any attached RCD equipment.

Var Details

var
accesses
– /list

A list of all granted accesses

var
active_thrusters
– /obj/item/mecha_parts/mecha_equipment/thrusters

/Action vars Ref to any active thrusters we might have

var
allow_diagonal_movement
–

Whether this mech is allowed to move diagonally

var
bumpsmash
–

Whether or not the mech destroys walls by running into it.

var
cabin_air
– /datum/gas_mixture

Internal air mix datum

var
cabin_sealed
–

////////ATMOS Whether the cabin exchanges gases with the environment

var
cabin_volume
–

Volume of the cabin

var
can_use_overclock
–

Whether it is possible to toggle overclocking from the cabin

var
capacitor
– /obj/item/stock_parts/capacitor

Keeps track of the mech's capacitor

var
cell
– /obj/item/stock_parts/cell

Keeps track of the mech's cell

var
chassis_camera
– /obj/machinery/camera/exosuit

Camera installed into the mech

var
completely_disabled
–

Just stop the mech from doing anything

var
component_damage_threshold
–

damage threshold above which we take component damage

var
defense_mode
–

Bool for energy shield on/off

var
destruction_sleep_duration
–

Time you get slept for if you get forcible ejected by the mech exploding

var
dna_lock
–

Stores the DNA enzymes of a carbon so tht only they can access the mech

var
equip_by_category
– /list

assoc list: key-typepathlist before init, key-equipmentlist after

var
equipment_disabled
–

if we cant use our equipment(such as due to EMP)

var
exit_delay
–

TIme taken to leave the mech

var
facing_modifiers
– /list

Modifiers for directional damage reduction

var
flat_equipment
– /list

flat equipment for iteration

var
internal_damage
–

Bitflags for internal damage

var
internal_damage_probability
–

% chance for internal damage to occur

var
internal_damage_threshold
–

damage amount above which we can take internal damages

var
is_currently_ejecting
–

Currently ejecting, and unable to do things

var
lavaland_only
–

Bool for whether this mech can only be used on lavaland

var
light_power_drain
–

Power we use to have the lights on

var
lights_power
–

How powerful our lights are

var
max_equip_by_category
– /list

assoc list: max equips for modules key-count

var
mech_type
–

single flag for the type of this mech, determines what kind of equipment can be attached to it

var
mecha_flags
–

Contains flags for the mecha

var
melee_cooldown
–

Cooldown duration between melee punches

var
melee_energy_drain
–

How much energy we drain each time we mechpunch someone

var
one_access
–

If the mech should require ALL or only ONE of the listed accesses

var
ore_box
– /obj/structure/ore_box

Handles an internal ore box for mining mechs

var
overclock_coeff
–

Speed and energy usage modifier for leg overload

var
overclock_mode
–

Bool for leg overload on/off

var
overclock_safety
–

Whether the overclocking turns off automatically when overheated

var
overclock_safety_available
–

Whether the mech has an option to enable safe overclocking

var
overclock_temp
–

Current leg actuator temperature. Increases when overloaded, decreases when not.

var
overclock_temp_danger
–

Temperature threshold at which actuators may start causing internal damage

var
phase_state
–

icon_state for flick() when phazing

var
phasing
–

check for phasing, if it is set to text (to describe how it is phasing: "flying", "phasing") it will let the mech walk through walls.

var
phasing_energy_drain
–

Power we use every time we phaze through something

var
pivot_step
–

Whether this mech moves into a direct as soon as it goes to move. Basically, turn and step in the same key press.

var
possible_int_damage
–

list of possibly dealt internal damage for this mech type

var
scanmod
– /obj/item/stock_parts/scanning_module

Keeps track of the mech's scanning module

var
servo
– /obj/item/stock_parts/servo

Keeps track of the mech's servo motor

var
silicon_icon_state
–

In case theres a different iconstate for AI/MMI pilot(currently only used for ripley)

var
smashcooldown
–

Cooldown length between bumpsmashes

var
smoke_charges
–

Remaining smoke charges

var
smoke_cooldown
–

Cooldown between using smoke

var
spark_system
– /datum/effect_system/spark_spread

Spark effects are handled by this datum

var
step_energy_drain
–

How much energy the mech will consume each time it moves. this is the current active energy consumed

var
step_silent
–

Whether our steps are silent due to no gravity

var
stepsound
–

Sound played when the mech moves

var
strafe
–

Wether we are strafing

var
trackers
– /list

List of installed remote tracking beacons, including AI control beacons

var
turnsound
–

Sound played when the mech walks

var
ui_selected_module_index
–

Module selected by default when mech UI is opened

var
ui_theme
–

Theme of the mech TGUI

var
ui_view
– /atom/movable/screen/map_view

ref to screen object that displays in the middle of the UI

var
updating
–

Portable camera camerachunk update

var
weapons_safety
–

Safety for weapons. Won't fire if enabled, and toggled by middle click.

var
wreckage
–

Typepath for the wreckage it spawns when destroyed

Proc Details

proc
ai_enter_mech
(/mob/living/silicon/ai/AI)

Hack and From Card interactions share some code, so leave that here for both to use.

proc
collect_ore
()

Collects ore when we move, if there is an orebox and it is functional

proc
diag_hud_set_camera
()

Shows inbuilt camera on the mech; if the camera's view range was affected by an EMP, shows a red blip while it's affected

proc
diag_hud_set_mechtracking
()

Shows tracking beacons on the mech

proc
display_speech_bubble
(/datum/source, /list/speech_args)

Displays a special speech bubble when someone inside the mecha speaks

proc
do_camera_update
(oldLoc)

The actual update - also passes our unique update buffer. This makes our static update faster than stationary cameras, helping us to avoid running out of the camera's FoV. An EMPd mecha with a lowered view_range on its camera can still sometimes run out into static before updating, however.

↑
generate_action_type
()

MECHA ACTIONS

proc
get_armour_facing
(relative_dir)

returns a number for the damage multiplier for this relative angle/dir

proc
get_int_repair_fluff_end
(flag)

gets the successful finish balloon alert flufftext

proc
get_int_repair_fluff_fail
(flag)

gets the on-fail balloon alert flufftext

proc
get_int_repair_fluff_start
(flag)

gets the starting balloon alert flufftext

proc
get_internal_tank
()

Locate an internal tack in the utility modules

proc
has_charge
(amount)

Power stuff

proc
max_ammo
()

// Ammo stuff /////

Max the ammo stored in all ballistic weapons for this mech

proc
mmi_move_inside
(/obj/item/mmi/brain_obj, /mob/user)

proc called when a new mmi mob tries to enter this mech

proc
mmi_moved_inside
(/obj/item/mmi/brain_obj, /mob/user)

proc called when a new mmi mob enters this mech

proc
moved_inside
(/mob/living/newoccupant)

proc called when a new non-mmi mob enters this mech

proc
on_click_alt
(/mob/user, /atom/target, params)

Driver alt clicks anything while in mech

proc
on_light_eater
(/obj/vehicle/sealed/source, /datum/light_eater)

Special light eater handling

proc
on_middlemouseclick
(/mob/user, /atom/target, params)

middle mouse click signal wrapper for AI users

proc
on_mouseclick
(/mob/user, /atom/target, /list/modifiers)

Called when a driver clicks somewhere. Handles everything like equipment, punches, etc.

proc
on_move
()

Called when the mech moves

proc
on_turn
(/mob/living/driver, direction)

Called when the driver turns with the movement lock key

proc
play_stepsound
()

Plays the mech step sound effect. Split from movement procs so that other mechs (HONK) can override this one specific part.

proc
populate_parts
()

If the former occupants get polymorphed, mutated, chestburstered, or otherwise replaced by another mob, that mob is no longer in .occupants and gets deleted with the mech. However, they do remain in .contents Add parts on mech spawning. Skipped in manual construction.

↑
remove_air
(amount)

Atmospheric stuff

proc
return_pressure
()

fetches pressure of the gas mixture we are using

↑
return_temperature
()

fetches temp of the gas mixture we are using

↑
setDir
(newdir)

Sets the direction of the mecha and all of its occcupents, required for FOV. Alternatively one could make a recursive contents registration and register topmost direction changes in the fov component

proc
set_cabin_seal
(/mob/user, cabin_sealed)

makes cabin unsealed, dumping cabin air outside or airtight filling the cabin with external air mix

proc
set_mouse_pointer
()

Updates the pilot's mouse cursor override.

If the mech's weapons safety is enabled, there should be no override, and the user gets their regular mouse cursor. If safety is off but the mech's equipment is disabled (such as by EMP), the cursor should be the red disabled version. Otherwise, if safety is off and the equipment is functional, the cursor should be the regular green cursor. This proc sets the cursor. correct and then updates it for each mob in the occupants list.

proc
set_safety
(/mob/user)

Toggles Weapons Safety

Handles enabling or disabling the safety function.

proc
shock
(/mob/living/user)

Electrocute user from power celll

proc
toggle_lights
(forced_state, /mob/user)

Toggle lights on/off

proc
toggle_overclock
(forced_state)

Toggle mech overclock with a button or by hacking

proc
try_damage_component
(damage, def_zone)

tries to damage mech equipment depending on damage and where is being targeted

proc
try_deal_internal_damage
(damage)

tries to deal internal damaget depending on the damage amount

proc
try_insert_part
(/obj/item/stock_parts/weapon, /mob/living/user)

Try to insert a stock part into the mech

proc
try_repair_int_damage
(/mob/user, flag_to_heal)

tries to repair any internal damage and plays fluff for it

proc
update_access
()

Apply corresponding accesses

proc
update_energy_drain
()

Update the energy drain according to parts and status

proc
upgrade_rcd
(/obj/item/rcd_upgrade/rcd_upgrade, /mob/user)

list of materials contained in the ammo box after we put it through the equation so we can stick this list into set_custom_materials() Upgrades any attached RCD equipment.

mecha /obj/vehicle/sealed/mecha

Vars

Procs

Var Details

var accesses – /list

var active_thrusters – /obj/item/mecha_parts/mecha_equipment/thrusters

var allow_diagonal_movement –

var bumpsmash –

var cabin_air – /datum/gas_mixture

var cabin_sealed –

var cabin_volume –

var can_use_overclock –

var capacitor – /obj/item/stock_parts/capacitor

var cell – /obj/item/stock_parts/cell

var chassis_camera – /obj/machinery/camera/exosuit

var completely_disabled –

var component_damage_threshold –

var defense_mode –

var destruction_sleep_duration –

var dna_lock –

var equip_by_category – /list

var equipment_disabled –

var exit_delay –

var facing_modifiers – /list

var flat_equipment – /list

var internal_damage –

var internal_damage_probability –

var internal_damage_threshold –

var is_currently_ejecting –

var lavaland_only –

var light_power_drain –

var lights_power –

var max_equip_by_category – /list

var mech_type –

var mecha_flags –

var melee_cooldown –

var melee_energy_drain –

var one_access –

var ore_box – /obj/structure/ore_box

var overclock_coeff –

var overclock_mode –

var overclock_safety –

var overclock_safety_available –

var overclock_temp –

var overclock_temp_danger –

var phase_state –

var phasing –

var phasing_energy_drain –

var pivot_step –

var possible_int_damage –

var scanmod – /obj/item/stock_parts/scanning_module

var servo – /obj/item/stock_parts/servo

var silicon_icon_state –

var smashcooldown –

var smoke_charges –

var smoke_cooldown –

var spark_system – /datum/effect_system/spark_spread

var step_energy_drain –

var step_silent –

var stepsound –

var strafe –

var trackers – /list

var turnsound –

var ui_selected_module_index –

var ui_theme –

var ui_view – /atom/movable/screen/map_view

var updating –

var weapons_safety –

var wreckage –