implant

Parent class for all implants

Vars
allow_multiple	if false, upon implantation of a duplicate implant, an attempt to combine the new implant's uses with the old one's uses will be made, deleting the new implant if successful or stopping the implantation if not
hud_icon_state	what icon state will we represent ourselves with on the hud?
imp_in	the mob that's implanted with this
implant_color	implant color, used for selecting either the "b" version or the "r" version of the implant case sprite when the implant is in a case.
implant_flags	our implant flags
implant_info	What's the most important info that we really, really care about, e.g. name, lifespan-after-death, utility?
implant_lore	What's the extended lore for this implant that we might not care that much about, e.g. descriptions, flavortext?
uses	how many times this can do something, only relevant for implants with limited uses
Procs
get_data	Gets the implant's info, for the implant pad.
get_lore	Gets the implant's lore info, also for the implant pad.
get_management_console_buttons	Returns a list of "structs" that translate into buttons displayed on the implant management console
get_management_console_data	Returns a list of information to show on the implant management console for this implant
handle_management_console_action	Handles a button click on the implant management console
implant	What does the implant do upon injection?
is_shown_on_console	Determines if the implant is visible on the implant management console. Note that this would only ever be called on implants currently inserted into a mob.
removed	Remove implant from mob.

Var Details

var
allow_multiple

if false, upon implantation of a duplicate implant, an attempt to combine the new implant's uses with the old one's uses will be made, deleting the new implant if successful or stopping the implantation if not

var
hud_icon_state

what icon state will we represent ourselves with on the hud?

var
imp_in
– /mob/living

the mob that's implanted with this

var
implant_color

implant color, used for selecting either the "b" version or the "r" version of the implant case sprite when the implant is in a case.

var
implant_flags

our implant flags

var
implant_info

What's the most important info that we really, really care about, e.g. name, lifespan-after-death, utility?

var
implant_lore

What's the extended lore for this implant that we might not care that much about, e.g. descriptions, flavortext?

var
uses

how many times this can do something, only relevant for implants with limited uses

Proc Details

proc
get_data
()

Gets the implant's info, for the implant pad.

proc
get_lore
()

Gets the implant's lore info, also for the implant pad.

proc
get_management_console_buttons
() as /list

Returns a list of "structs" that translate into buttons displayed on the implant management console

The struct should have the following keys:

name - the name of the button, optional if button_icon is set
icon - the icon of the button, optional if button_name is set
color - the color of the button, optional
tooltip - the tooltip of the button, optional
action_key - the key that will be passed to handle_management_console_action when the button is clicked
action_params - optional, additional params passed when the button is clicked

proc
get_management_console_data
() as /list

Returns a list of information to show on the implant management console for this implant

Unlike normal UI data, the keys of the list are shown on the UI itself, so they should be human readable.

proc
handle_management_console_action
(/mob/user, /list/params, /obj/machinery/computer/prisoner/management/console)

Handles a button click on the implant management console

user - the mob clicking the button
params - the params passed to the button, as if this were a ui_act handler. See params["implant_action"] for the action key passed to the button (which should correspond to a button returned by get_management_console_buttons)
console - the console the button was clicked on

proc
implant
(/mob/living/target, /mob/user, silent, force)

What does the implant do upon injection?

return true if the implant injects return false if there is no room for implant / it fails Arguments:

mob/living/target - mob being implanted
mob/user - mob doing the implanting
silent - unused here
force - if true, implantation will not fail if can_be_implanted_in returns false

proc
is_shown_on_console
(/obj/machinery/computer/prisoner/management/console)

Determines if the implant is visible on the implant management console. Note that this would only ever be called on implants currently inserted into a mob.

proc
removed
(/mob/living/source, silent, special)

Remove implant from mob.

This removes the effects of the implant and moves it out of the mob and into nullspace. Arguments:

mob/living/source - What the implant is being removed from
silent - unused here
special - Set to true if removed by admin panel, should bypass any side effects

implant /obj/item/implant

Vars

Procs

Var Details

var allow_multiple

var hud_icon_state

var imp_in – /mob/living

var implant_color

var implant_flags

var implant_info

var implant_lore

var uses

Proc Details

proc get_data()

proc get_lore()

proc get_management_console_buttons() as /list

proc get_management_console_data() as /list

proc handle_management_console_action(/mob/user, /list/params, /obj/machinery/computer/prisoner/management/console)

proc implant(/mob/living/target, /mob/user, silent, force)

proc is_shown_on_console(/obj/machinery/computer/prisoner/management/console)

proc removed(/mob/living/source, silent, special)