elevator_master

Vars
button	The button machine used by the elevator "car" to control its destination floor.
cur_index	The index into the floor list at which the current floor datum resides. Numbers displayed to players are modified by floor_offset and fake_floors.
cur_state	The elevator's current state. The elevator clears all pending calls / destinations through a chain of procs linked by timers: check_move() -> move_elevator() -> arrive_on_floor() -> optionally, cycle_doors() -> check_move(). Occasionally, cycle_doors() will be the entry point instead. During this chain, cur_state is ELEVATOR_BUSY. Otherwise, the elevator is in ELEVATOR_IDLE, and may be activated if a new call or destination is registered.
display	The button machine used by the elevator "car" to display its current floor, heading direction, and to play sounds from.
door_open_time	amount of time spent on a floor after arriving but before opening doors
fake_floors	If this variable is a positive integer, the status display and elevator buttons will act as though the first fake_floors floors exist, but are inaccessible. For example, with a floor_offset of -1 and a fake_floors of 2, the floor controls will display 2 unreachable floors at the bottom of the panel with values "0" and "1". This only affects player-facing displays: floor_list and cur_index behave exactly the same regardless of this value.
floor_idle_time	amount of time spent between opening doors and closing them
floor_list	List of floor datums that the elevator may move between.
floor_move_time	amount of time spent between floors while moving
floor_offset	Player-facing floor numbers are offset by this value. Thus, with the default floor_offset as -1, the first floor will show as floor "0", the second as floor "1", and so on. This only affects player-facing displays: floor_list and cur_index behave exactly the same regardless of this value.
platforms	The list of elevator platforms to be moved by the elevator master. This is the part of the elevator that players and items are moved by.
seeking_dir	The direction the elevator is looking for future stops in. This enables the elevator to skip a floor with an order to go DOWN when it is heading UP. Value is either the dir UP or the dir DOWN, for simplicity.
Procs
add_floor	Adds a floor to the elevator's floor list. Default behavior is to append the floor. Index passed should not exceed the floor list's current length.
add_floor_landmarks	Given an elevator landmark and list of elevator machine landmarks, creates a floor by calling add_floor and qdeletes the passed landmarks after pulling the objects they mark.
add_platform	Adds an elevator platform to the list of linked platforms.
remove_floor	Removes a floor from the elevator's floor list. If the floor is equal to the elevator's current floor, fails and returns FALSE. Otherwise, the floor is removed, the current floor's number is updated if necessary, and returns TRUE. Currently unused.
remove_platform	Removes an elevator platform from the list of linked platforms.

Var Details

var
button
– /obj/machinery/elevator_floor_button

The button machine used by the elevator "car" to control its destination floor.

var
cur_index
–

The index into the floor list at which the current floor datum resides. Numbers displayed to players are modified by floor_offset and fake_floors.

var
cur_state
–

The elevator's current state. The elevator clears all pending calls / destinations through a chain of procs linked by timers: check_move() -> move_elevator() -> arrive_on_floor() -> optionally, cycle_doors() -> check_move(). Occasionally, cycle_doors() will be the entry point instead. During this chain, cur_state is ELEVATOR_BUSY. Otherwise, the elevator is in ELEVATOR_IDLE, and may be activated if a new call or destination is registered.

var
display
– /obj/machinery/status_display/elevator

The button machine used by the elevator "car" to display its current floor, heading direction, and to play sounds from.

var
door_open_time
–

amount of time spent on a floor after arriving but before opening doors

var
fake_floors
–

If this variable is a positive integer, the status display and elevator buttons will act as though the first fake_floors floors exist, but are inaccessible. For example, with a floor_offset of -1 and a fake_floors of 2, the floor controls will display 2 unreachable floors at the bottom of the panel with values "0" and "1". This only affects player-facing displays: floor_list and cur_index behave exactly the same regardless of this value.

var
floor_idle_time
–

amount of time spent between opening doors and closing them

var
floor_list
– /list/datum/floor

List of floor datums that the elevator may move between.

var
floor_move_time
–

amount of time spent between floors while moving

var
floor_offset
–

Player-facing floor numbers are offset by this value. Thus, with the default floor_offset as -1, the first floor will show as floor "0", the second as floor "1", and so on. This only affects player-facing displays: floor_list and cur_index behave exactly the same regardless of this value.

var
platforms
– /list/obj/structure/elevator_platform

The list of elevator platforms to be moved by the elevator master. This is the part of the elevator that players and items are moved by.

var
seeking_dir
–

The direction the elevator is looking for future stops in. This enables the elevator to skip a floor with an order to go DOWN when it is heading UP. Value is either the dir UP or the dir DOWN, for simplicity.

Proc Details

proc
add_floor
(/turf/anchor, /obj/machinery/elevator_call_button/button, /list/obj/machinery/door/doors, index)

Adds a floor to the elevator's floor list. Default behavior is to append the floor. Index passed should not exceed the floor list's current length.

proc
add_floor_landmarks
(/obj/effect/landmark/outpost/elevator/anchor, /list/obj/effect/landmark/outpost/elevator_machine/machine_marks)

Given an elevator landmark and list of elevator machine landmarks, creates a floor by calling add_floor and qdeletes the passed landmarks after pulling the objects they mark.

proc
add_platform
(/obj/structure/elevator_platform/new_platform)

Adds an elevator platform to the list of linked platforms.

proc
remove_floor
(index)

Removes a floor from the elevator's floor list. If the floor is equal to the elevator's current floor, fails and returns FALSE. Otherwise, the floor is removed, the current floor's number is updated if necessary, and returns TRUE. Currently unused.

proc
remove_platform
(/obj/structure/elevator_platform/old_platform)

Removes an elevator platform from the list of linked platforms.

elevator_master /datum/elevator_master

Vars

Procs

Var Details

var button – /obj/machinery/elevator_floor_button

var cur_index –

var cur_state –

var display – /obj/machinery/status_display/elevator

var door_open_time –

var fake_floors –

var floor_idle_time –

var floor_list – /list/datum/floor

var floor_move_time –

var floor_offset –

var platforms – /list/obj/structure/elevator_platform

var seeking_dir –