lift_master

coordinate and control movement across linked industrial_lift's. allows moving large single multitile platforms and many 1 tile platforms. also is capable of linking platforms across linked z levels

Vars
controls_locked	if true, the lift cannot be manually moved.
create_multitile_platform	taken from our lift platforms. if true we go through each z level of platforms and attempt to make the lowest left corner platform into one giant multitile object the size of all other platforms on that z level.
ignored_smashthroughs	Typepath list of what to ignore smashing through, controls all lifts
lift_id	lift_id taken from our base lift platform, used to put us into GLOB.active_lifts_by_type
lift_platforms	the lift platforms we consider as part of this lift. ordered in order of lowest z level to highest z level after init. (the sorting algorithm sucks btw)
multitile_platform	whether the lift handled by this lift_master datum is multitile as opposed to nxm platforms per z level
specific_lift_id	overridable ID string to link control units to this specific lift_master datum. created by placing a lift id landmark object somewhere on the tram, if its anywhere on the tram we'll find it in init and set this to whatever it specifies
z_sorted	lift platforms have already been sorted in order of z level.
Procs
Check_lift_move	Check destination turfs
Rebuild_lift_plaform	Collect all bordered platforms via a simple floodfill algorithm. allows multiz trams because its funny
check_for_landmarks	check for any landmarks placed inside the locs of the given lift_platform
create_multitile_platform_for_z_level	goes through all platforms in the given list and finds the one in the lower left corner
finish_simple_move_wrapper	Wrap everything up from simple_move_wrapper finishing its movement
get_platforms_on_level	returns all industrial_lifts associated with this tram on the given z level or given atoms z level
get_zs_we_are_on	Returns a list of all the z-levels our lift is currently on.
move_after_delay	Moves the lift after a passed delay.
move_lift_horizontally	Moves the lift, this is what users invoke with their hand. This is a SAFE proc, ensuring every part of the lift moves SANELY. It also locks controls for the (miniscule) duration of the movement, so the elevator cannot be broken by spamming.
move_lift_vertically	Moves the lift UP or DOWN, this is what users invoke with their hand. This is a SAFE proc, ensuring every part of the lift moves SANELY.
move_to_zlevel	Moves the lift to the passed z-level.
open_lift_doors_callback	Helper used in callbacks to open all the doors our lift is on
order_platforms_by_z_level	orders the lift platforms in order of lowest z level to highest z level.
reset_lift_contents	resets the contents of all platforms to their original state in case someone put a bunch of shit onto the tram. intended to be called by admins. passes all arguments to reset_contents() for each of our platforms.
return_closest_platform_to	returns the closest lift to the specified atom, prioritizing lifts on the same z level. used for comparing distance
return_closest_platform_to_z	Returns a lift platform on the z-level which is vertically closest to the passed target_z
set_controls	Sets all lift parts's controls_locked variable. Used to prevent moving mid movement, or cooldowns.
set_info_from_id_landmark	set vars and such given an overriding lift_id landmark
simple_move_wrapper	Simple wrapper for checking if we can move 1 zlevel, and if we can, do said move. Locks controls, closes all doors, then moves the lift and re-opens the doors afterwards.
update_lift_doors	Updates all blast doors and shutters that share an ID with our lift.

Var Details

var
controls_locked
–

if true, the lift cannot be manually moved.

var
create_multitile_platform
–

taken from our lift platforms. if true we go through each z level of platforms and attempt to make the lowest left corner platform into one giant multitile object the size of all other platforms on that z level.

var
ignored_smashthroughs
– /static/list

Typepath list of what to ignore smashing through, controls all lifts

var
lift_id
–

lift_id taken from our base lift platform, used to put us into GLOB.active_lifts_by_type

var
lift_platforms
– /list/obj/structure/industrial_lift

the lift platforms we consider as part of this lift. ordered in order of lowest z level to highest z level after init. (the sorting algorithm sucks btw)

var
multitile_platform
–

whether the lift handled by this lift_master datum is multitile as opposed to nxm platforms per z level

var
specific_lift_id
–

overridable ID string to link control units to this specific lift_master datum. created by placing a lift id landmark object somewhere on the tram, if its anywhere on the tram we'll find it in init and set this to whatever it specifies

var
z_sorted
–

lift platforms have already been sorted in order of z level.

Proc Details

proc
Check_lift_move
(check_dir)

Check destination turfs

proc
Rebuild_lift_plaform
(/obj/structure/industrial_lift/base_lift_platform)

Collect all bordered platforms via a simple floodfill algorithm. allows multiz trams because its funny

proc
check_for_landmarks
(/obj/structure/industrial_lift/new_lift_platform)

check for any landmarks placed inside the locs of the given lift_platform

proc
create_multitile_platform_for_z_level
(/list/obj/structure/industrial_lift/platforms_in_z)

goes through all platforms in the given list and finds the one in the lower left corner

proc
finish_simple_move_wrapper
()

Wrap everything up from simple_move_wrapper finishing its movement

proc
get_platforms_on_level
(/atom/atom_reference_OR_z_level_number)

returns all industrial_lifts associated with this tram on the given z level or given atoms z level

proc
get_zs_we_are_on
()

Returns a list of all the z-levels our lift is currently on.

proc
move_after_delay
(lift_move_duration, door_duration, direction, /mob/user)

Moves the lift after a passed delay.

This is a more "user friendly" or "realistic" lift move. It includes things like:

Allowing lift "travel time"
Shutting elevator safety doors
Sound effects while moving
Safety warnings for anyone below the lift (while it's moving downwards)

Arguments: duration - required, how long do we wait to move the lift? door_duration - optional, how long should we wait to open the doors after arriving? If null, we won't open or close doors direction - which direction are we moving the lift? user - optional, who is moving the lift?

proc
move_lift_horizontally
(going)

Moves the lift, this is what users invoke with their hand. This is a SAFE proc, ensuring every part of the lift moves SANELY. It also locks controls for the (miniscule) duration of the movement, so the elevator cannot be broken by spamming.

proc
move_lift_vertically
(going, /mob/user)

Moves the lift UP or DOWN, this is what users invoke with their hand. This is a SAFE proc, ensuring every part of the lift moves SANELY.

Arguments: going - UP or DOWN directions, where the lift should go. Keep in mind by this point checks of whether it should go up or down have already been done. user - Whomever made the lift movement.

proc
move_to_zlevel
(target_z, /datum/callback/loop_callback, /mob/user)

Moves the lift to the passed z-level.

Checks for validity of the move: Are we moving to the same z-level, can we actually move to that z-level? Does NOT check if the lift controls are currently locked.

Moves to the passed z-level by calling move_after_delay repeatedly until the passed z-level is reached. This proc sleeps as it moves.

Arguments: target_z - required, the Z we want to move to loop_callback - optional, an additional callback invoked during the l oop that allows the move to cancel. user - optional, who started the move

proc
open_lift_doors_callback
()

Helper used in callbacks to open all the doors our lift is on

proc
order_platforms_by_z_level
()

orders the lift platforms in order of lowest z level to highest z level.

proc
reset_lift_contents
(consider_anything_past, foreign_objects, foreign_non_player_mobs, consider_player_mobs)

resets the contents of all platforms to their original state in case someone put a bunch of shit onto the tram. intended to be called by admins. passes all arguments to reset_contents() for each of our platforms.

Arguments:

consider_anything_past - number. if > 0 our platforms will only handle foreign contents that exceed this number in each of their locs
foreign_objects - bool. if true our platforms will consider /atom/movable's that arent mobs as part of foreign contents
foreign_non_player_mobs - bool. if true our platforms consider mobs that dont have a mind to be foreign
consider_player_mobs - bool. if true our platforms consider player mobs to be foreign. only works if foreign_non_player_mobs is true as well

proc
return_closest_platform_to
(/atom/comparison, allow_multiple_answers)

returns the closest lift to the specified atom, prioritizing lifts on the same z level. used for comparing distance

proc
return_closest_platform_to_z
(target_z)

Returns a lift platform on the z-level which is vertically closest to the passed target_z

proc
set_controls
(state)

Sets all lift parts's controls_locked variable. Used to prevent moving mid movement, or cooldowns.

proc
set_info_from_id_landmark
(/obj/effect/landmark/lift_id/landmark)

set vars and such given an overriding lift_id landmark

proc
simple_move_wrapper
(direction, lift_move_duration, /mob/user)

Simple wrapper for checking if we can move 1 zlevel, and if we can, do said move. Locks controls, closes all doors, then moves the lift and re-opens the doors afterwards.

Arguments: direction - which direction are we moving? lift_move_duration - how long does the move take? can be 0 or null for instant move. door_duration - how long does it take for the doors to open after a move? user - optional, who moved it?

proc
update_lift_doors
(on_z_level, action)

Updates all blast doors and shutters that share an ID with our lift.

Arguments: on_z_level - optional, only open doors on this z-level or list of z-levels action - how do we update the doors? OPEN_DOORS to make them open, CLOSE_DOORS to make them shut

lift_master /datum/lift_master

Vars

Procs

Var Details

var controls_locked –

var create_multitile_platform –

var ignored_smashthroughs – /static/list

var lift_id –

var lift_platforms – /list/obj/structure/industrial_lift

var multitile_platform –

var specific_lift_id –

var z_sorted –

Proc Details

proc Check_lift_move(check_dir)

proc Rebuild_lift_plaform(/obj/structure/industrial_lift/base_lift_platform)

proc check_for_landmarks(/obj/structure/industrial_lift/new_lift_platform)

proc create_multitile_platform_for_z_level(/list/obj/structure/industrial_lift/platforms_in_z)

proc finish_simple_move_wrapper()

proc get_platforms_on_level(/atom/atom_reference_OR_z_level_number)

proc get_zs_we_are_on()

proc move_after_delay(lift_move_duration, door_duration, direction, /mob/user)

proc move_lift_horizontally(going)

proc move_lift_vertically(going, /mob/user)

proc move_to_zlevel(target_z, /datum/callback/loop_callback, /mob/user)

proc open_lift_doors_callback()

proc order_platforms_by_z_level()

proc reset_lift_contents(consider_anything_past, foreign_objects, foreign_non_player_mobs, consider_player_mobs)

proc return_closest_platform_to(/atom/comparison, allow_multiple_answers)

proc return_closest_platform_to_z(target_z)

proc set_controls(state)

proc set_info_from_id_landmark(/obj/effect/landmark/lift_id/landmark)

proc simple_move_wrapper(direction, lift_move_duration, /mob/user)

proc update_lift_doors(on_z_level, action)