Safe

A locked container that can only be opened by entering a combination through a dial.
Vars | |
current_tumbler_index | The index in the tumblers list of the tumbler dial position that needs to be hit. |
---|---|
dial | The position the dial is pointing to. |
drill | The currently placed thermal drill, if any. |
drill_overlay | The drill overlay image to display during the drilling process. |
drill_start_time | The world.time at which drilling started. |
drill_timer | The /proc/addtimer handle for the current thermal drill. |
drill_x_offset | The X pixel offset for the drilling progress bar. |
drill_y_offset | The Y pixel offset for the drilling progress bar. |
driller | Who placed the drill on the safe. Used to trigger the status effect |
known_by | Used by /obj/item/paper/safe_code to tell the codes through a paper spawned on map load. |
locked | Whether the safe is locked or not. |
maxspace | The maximum combined w_class of stuff in the safe. |
number_of_tumblers | The amount of tumblers that will be generated. |
open | Whether the safe is open or not. |
progress_bar | The progress bar image to display during the drilling process. |
space | The combined w_class of everything in the safe. |
time_to_drill | Drill duration of the current thermal drill. |
tumblers | The list of tumbler dial positions that need to be hit. |
Procs | |
check_unlocked | Called every dial turn to determine whether the safe should unlock or not. |
drill_open | Called when the current thermal drill has finished drilling. |
get_combination | Returns the combination to unlock the safe as text. |
notify_user | Called every dial turn to provide feedback if possible. |
Var Details
current_tumbler_index

The index in the tumblers list of the tumbler dial position that needs to be hit.
dial

The position the dial is pointing to.
drill

The currently placed thermal drill, if any.
drill_overlay

The drill overlay image to display during the drilling process.
drill_start_time

The world.time at which drilling started.
drill_timer

The /proc/addtimer handle for the current thermal drill.
drill_x_offset

The X pixel offset for the drilling progress bar.
drill_y_offset

The Y pixel offset for the drilling progress bar.
driller

Who placed the drill on the safe. Used to trigger the status effect
known_by

Used by /obj/item/paper/safe_code to tell the codes through a paper spawned on map load.
locked

Whether the safe is locked or not.
maxspace

The maximum combined w_class of stuff in the safe.
number_of_tumblers

The amount of tumblers that will be generated.
open

Whether the safe is open or not.
progress_bar

The progress bar image to display during the drilling process.
space

The combined w_class of everything in the safe.
time_to_drill

Drill duration of the current thermal drill.
tumblers

The list of tumbler dial positions that need to be hit.
Proc Details
check_unlocked
Called every dial turn to determine whether the safe should unlock or not.
drill_open
Called when the current thermal drill has finished drilling.
get_combination
Returns the combination to unlock the safe as text.
notify_user
Called every dial turn to provide feedback if possible.