lockable

Extension for giving an object a code lock, with it's own ui.

Vars
code	The passcode currently inputed so far and what is displayed on the UI.
emagged	Whether or not the lock is emagged.
error	Error text currently displayed to the user. Temporary.
is_digital_lock	Whether or not the lock is digital, and its ability to be brute forced.
l_code	The code to unlock the lock
l_hacking	Whether or not the lock is being hacked.
l_set	Whether or not the lock has been set.
l_setshort	Whether or not the ability to set the lock is broken.
locked	Whether the lock is locked.
max_code_length	Max length of the password.
open	Whether or not the lock service panel is open.
opening_panel	Whether we're currently opening the panel or not. (Unskilled people can take a long time to open it)
sound_range	The absolute range in turfs the lockable's sounds can be heard at from the holder's position.
Procs
attackby	Item attack handler for interactions with the host.
bad_access_attempt	Called after the user enters the wrong keycode, or fails a hacking attempt.
can_interact	Whether the user can actually issue commands to the ui.
clear_button	Clears the currently entered code and the current error text, and lock the lockable if it's not already.
clear_current_code	Clear the currently entered code on the ui.
clear_error	Clear the currently displayed error text on the ui.
confirm_code	Called when the user press the enter key on the lockable keypad, or when the last key of the code is entered. Either sets the keycode for unlocking this lockable, or checks if the current keycode entered is the correct one, and unlocks the lockable. Returns TRUE if the code entered was appropriate.
emag_act	Called when an emag is used on the holder.
enter_number	Called whenever the user input a number key. Adds the value of the key to the currently entered keycode.
hack_fail_chance	Returns a percent chance of the given user failing at hacking this lock.
is_locked	Whether the lockable is currently locked or not.
is_setting_keycode	Whether we're currently awaiting a keycode input to set the keycode to unlock this lockable.
keycode_issues_text	Checks the given code for any issues with using it as this lockable's keycode. Returns null if there are no problems. Or a text string describing the problem otherwise.
matches_keycode	Whether the incoming keycode matches the keycode we have set to unlock this lockable.
play_code_set_sound	Makes the holder play the sound after a new keycode has been set.
play_failure_sound	Makes the holder play the failure sound, when an invalid operation has been done.
play_key_sound	Makes the holder play a sound when a keypad key has been pressed.
play_lock_sound	Makes the holder play the lock's locking sound.
play_success_sound	Makes the holder play the success sound, when an operation was successful.
play_unlock_sound	Makes the holder play the lock's unlock sound.
pressed_key	Process keypresses coming from the nanoUI.
reset_memory	Clears the currently set keycode, hacked state, and shorted state. Called by the hacking proc via timer after a short delay.
set_error_message	Sets the error message to be displayed currently.
set_keycode	Sets the keycode that unlocks this lockable.
set_locked	Locks or unlocks the lockable. And play a sound.
toggle_panel	Opens the "service panel" for nefarious purposes.
try_hack	Called when a multitool is used on the holder to hack the device.

Var Details

var
code
– /tmp

The passcode currently inputed so far and what is displayed on the UI.

var
emagged
–

Whether or not the lock is emagged.

var
error
– /tmp

Error text currently displayed to the user. Temporary.

var
is_digital_lock
–

Whether or not the lock is digital, and its ability to be brute forced.

var
l_code
–

The code to unlock the lock

var
l_hacking
– /tmp

Whether or not the lock is being hacked.

var
l_set
–

Whether or not the lock has been set.

var
l_setshort
–

Whether or not the ability to set the lock is broken.

var
locked
–

Whether the lock is locked.

var
max_code_length
–

Max length of the password.

var
open
–

Whether or not the lock service panel is open.

var
opening_panel
– /tmp

Whether we're currently opening the panel or not. (Unskilled people can take a long time to open it)

var
sound_range
–

The absolute range in turfs the lockable's sounds can be heard at from the holder's position.

Proc Details

proc
attackby
(/obj/item/used_item, /mob/user)

Item attack handler for interactions with the host.

proc
bad_access_attempt
(/mob/user)

Called after the user enters the wrong keycode, or fails a hacking attempt.

proc
can_interact
(/mob/user)

Whether the user can actually issue commands to the ui.

proc
clear_button
(/mob/user, quiet)

Clears the currently entered code and the current error text, and lock the lockable if it's not already.

proc
clear_current_code
()

Clear the currently entered code on the ui.

proc
clear_error
()

Clear the currently displayed error text on the ui.

proc
confirm_code
(/mob/user, quiet)

Called when the user press the enter key on the lockable keypad, or when the last key of the code is entered. Either sets the keycode for unlocking this lockable, or checks if the current keycode entered is the correct one, and unlocks the lockable. Returns TRUE if the code entered was appropriate.

proc
emag_act
(remaining_charges, /mob/user, feedback)

Called when an emag is used on the holder.

proc
enter_number
(num, /mob/user, quiet)

Called whenever the user input a number key. Adds the value of the key to the currently entered keycode.

proc
hack_fail_chance
(/obj/item/multitool/W, /mob/user)

Returns a percent chance of the given user failing at hacking this lock.

proc
is_locked
()

Whether the lockable is currently locked or not.

proc
is_setting_keycode
()

Whether we're currently awaiting a keycode input to set the keycode to unlock this lockable.

proc
keycode_issues_text
(code)

Checks the given code for any issues with using it as this lockable's keycode. Returns null if there are no problems. Or a text string describing the problem otherwise.

proc
matches_keycode
(incoming)

Whether the incoming keycode matches the keycode we have set to unlock this lockable.

proc
play_code_set_sound
()

Makes the holder play the sound after a new keycode has been set.

proc
play_failure_sound
()

Makes the holder play the failure sound, when an invalid operation has been done.

proc
play_key_sound
(key, /mob/user, user_only)

Makes the holder play a sound when a keypad key has been pressed.

key: A single key character that was pressed. Any leters between A to Z, any numbers between 0-9, or *, #, ⌗, ⚹.
user: The user inputing the key.
user_only: If set, the key sound will only be sent to the client using the keypad.

proc
play_lock_sound
()

Makes the holder play the lock's locking sound.

proc
play_success_sound
()

Makes the holder play the success sound, when an operation was successful.

proc
play_unlock_sound
()

Makes the holder play the lock's unlock sound.

proc
pressed_key
(key_char, /mob/user)

Process keypresses coming from the nanoUI.

proc
reset_memory
()

Clears the currently set keycode, hacked state, and shorted state. Called by the hacking proc via timer after a short delay.

proc
set_error_message
(msg)

Sets the error message to be displayed currently.

proc
set_keycode
(new_code, quiet)

Sets the keycode that unlocks this lockable.

proc
set_locked
(new_state, quiet)

Locks or unlocks the lockable. And play a sound.

proc
toggle_panel
(/mob/user)

Opens the "service panel" for nefarious purposes.

proc
try_hack
(/obj/item/multitool/W, /mob/user)

Called when a multitool is used on the holder to hack the device.

lockable /datum/extension/lockable

Vars

Procs

Var Details

var code – /tmp

var emagged –

var error – /tmp

var is_digital_lock –

var l_code –

var l_hacking – /tmp

var l_set –

var l_setshort –

var locked –

var max_code_length –

var open –

var opening_panel – /tmp

var sound_range –

Proc Details

proc attackby(/obj/item/used_item, /mob/user)

proc bad_access_attempt(/mob/user)

proc can_interact(/mob/user)

proc clear_button(/mob/user, quiet)

proc clear_current_code()

proc clear_error()

proc confirm_code(/mob/user, quiet)

proc emag_act(remaining_charges, /mob/user, feedback)

proc enter_number(num, /mob/user, quiet)

proc hack_fail_chance(/obj/item/multitool/W, /mob/user)

proc is_locked()

proc is_setting_keycode()

proc keycode_issues_text(code)

proc matches_keycode(incoming)

proc play_code_set_sound()

proc play_failure_sound()

proc play_key_sound(key, /mob/user, user_only)

proc play_lock_sound()

proc play_success_sound()

proc play_unlock_sound()

proc pressed_key(key_char, /mob/user)

proc reset_memory()

proc set_error_message(msg)

proc set_keycode(new_code, quiet)

proc set_locked(new_state, quiet)

proc toggle_panel(/mob/user)

proc try_hack(/obj/item/multitool/W, /mob/user)