organ

Vars
color_source	Where does this organ inherit it's color from?
cosmetic_only	If the organ is cosmetic only, it loses all organ functionality.
damage	Total damage this organ has sustained Should only ever be modified by applyOrganDamage
dna_block	With what DNA block do we mutate in mutate_feature() ? For genetics
draw_color	The color this organ draws with. Updated by bodypart/inherit_color()
external_bodytypes	Does this organ have any bodytypes to pass to it's ownerlimb?
external_damage_modifier	Amount of damage to take when taking damage from an external source
feature_key	Defines what kind of 'organ' we're looking at. Sprites have names like 'm_mothwings_firemoth'. 'mothwings' would then be feature_key
layers	Sometimes we need multiple layers, for like the back, middle and front of the person
mutcolor_index	Which index of the mutcolor key list to use. Defaults to 1, so MUTCOLORS_GENERIC_1 if mutcolor_used is MUTCOLORS_KEY_GENERIC
mutcolor_used	See above
mutcolors	Used by ORGAN_COLOR_INHERIT_ALL, allows full control of the owner's mutcolors
organ_traits	Traits that are given to the holder of the organ. If you want an effect that changes this, don't add directly to this. Use the add_organ_trait() proc
owner	The mob that owns this organ.
ownerlimb	Reference to the limb we're inside of
preference	The savefile_key of the preference this relates to. Used for the preferences UI.
prev_damage	Organ variables for determining what we alert the owner with when they pass/clear the damage thresholds
reagent_vol	The size of the reagent container
relative_size	The relative size of this organ, used for probability to hit.
render_key	Similar to feature key, but overrides it in the case you need more fine control over the iconstate, like with Tails.
severe_cooldown	cooldown for severe effects, used for synthetic organ emp effects.
slot	The organ slot this organ is supposed to inhabit. This should be unique by type. (Lungs, Appendix, Stomach, etc)
sprite_datum	Sprite datum we use to draw on the bodypart
stored_feature_id	Stores the dna.features[feature_key], used for external organs that can be surgically removed or inserted.
time_of_death	The world.time of this organ's death
useable	When you take a bite you cant jam it in for surgery anymore.
visual	Do we effect the appearance of our mob. Used to save time in preference code
zone	The body zone this organ is supposed to inhabit.
Procs
PreRevivalInsertion	processing_organs must ALWAYS be ordered in the same way as organ_process_order Otherwise life processing breaks down
add_organ_trait	Add a trait to an organ that it will give its owner.
applyOrganDamage	Adjusts an organ's damage by the amount "damage_amount", up to a maximum amount, which is by default max damage
attempt_vital_organ_revival	Called by Insert() if the organ is vital and the target is dead.
before_organ_replacement	Called before organs are replaced in regenerate_organs with new ones
build_cache_key	Generate a unique key based on our sprites. So that if we've aleady drawn these sprites, they can be found in the cache and wont have to be drawn again (blessing and curse)
build_overlays	Build overlays
can_draw_on_bodypart	Check whether we can draw the overlays. You generally don't want lizard snouts to draw over an EVA suit
can_recover	Can this organ be revived from the dead?
check_damage_thresholds
check_failing_thresholds	Checks if an organ should/shouldn't be failing and gives the appropriate organ flag
cut_away	Cut an organ away from it's container, but do not remove it from the container physically.
ex_act	A little hack to ensure old behavior.
exit_wardrobe	Used as callbacks by object pooling
get_availability
get_global_feature_list	Return a dumb glob list for this specific feature (called from parse_sprite)
get_overlays	Add the overlays we need to draw on a person. Called from _bodyparts.dm
get_scan_results	Called by medical scanners to get a simple summary of how healthy the organ is. Returns an empty string if things are fine.
inherit_color	Give the organ it's color. Force will override the existing one.
mutate_feature	Update our features after something changed our appearance
on_death	This is on_life() but for when the organ is dead or outside of a mob. Bad name.
on_life	Called once every life tick on every organ in a carbon's body NOTE: THIS IS VERY HOT. Be careful what you put in here To give you some scale, if there's 100 carbons in the game, they each have maybe 9 organs So that's 900 calls to this proc every life process. Please don't be dumb Return TRUE to call updatehealth(). Please only call inside of on_life() if it's important.
override_color	Colorizes the limb it's inserted to, if required.
remove_organ_trait	Removes a trait from an organ, and by extension, its owner.
setOrganDamage	SETS an organ's damage to the amount "damage_amount", and in doing so clears or sets the failing flag, good for when you have an effect that should fix an organ if broken
set_organ_dead	Set or unset the organ as failing. Returns TRUE on success.
set_sprite	System for drawing organs with overlays. These overlays are drawn directly on the bodypart, attached to a person or not Works in tandem with the /datum/sprite_accessory datum to generate sprites Unlike normal organs, we're actually inside a persons limbs at all times
surgically_fix	Used for the fix_organ surgery, lops off some of the maxHealth if the organ was very damaged.
update_organ_traits	Updates the traits of the organ on the specific organ it is called on. Should be called anytime an organ is given a trait while it is already in a body.

Var Details

var
color_source
–

Where does this organ inherit it's color from?

var
cosmetic_only
–

If the organ is cosmetic only, it loses all organ functionality.

var
damage
–

Total damage this organ has sustained Should only ever be modified by applyOrganDamage

var
dna_block
–

With what DNA block do we mutate in mutate_feature() ? For genetics

var
draw_color
–

The color this organ draws with. Updated by bodypart/inherit_color()

var
external_bodytypes
–

Does this organ have any bodytypes to pass to it's ownerlimb?

var
external_damage_modifier
–

Amount of damage to take when taking damage from an external source

var
feature_key
–

Defines what kind of 'organ' we're looking at. Sprites have names like 'm_mothwings_firemoth'. 'mothwings' would then be feature_key

var
layers
– /list

Sometimes we need multiple layers, for like the back, middle and front of the person

var
mutcolor_index
–

Which index of the mutcolor key list to use. Defaults to 1, so MUTCOLORS_GENERIC_1 if mutcolor_used is MUTCOLORS_KEY_GENERIC

var
mutcolor_used
–

See above

var
mutcolors
– /list

Used by ORGAN_COLOR_INHERIT_ALL, allows full control of the owner's mutcolors

var
organ_traits
– /list

Traits that are given to the holder of the organ. If you want an effect that changes this, don't add directly to this. Use the add_organ_trait() proc

var
owner
– /mob/living/carbon

The mob that owns this organ.

var
ownerlimb
– /obj/item/bodypart

Reference to the limb we're inside of

var
preference
–

The savefile_key of the preference this relates to. Used for the preferences UI.

var
prev_damage
–

Organ variables for determining what we alert the owner with when they pass/clear the damage thresholds

var
reagent_vol
–

The size of the reagent container

var
relative_size
–

The relative size of this organ, used for probability to hit.

var
render_key
–

Similar to feature key, but overrides it in the case you need more fine control over the iconstate, like with Tails.

var
severe_cooldown
–

cooldown for severe effects, used for synthetic organ emp effects.

var
slot
–

The organ slot this organ is supposed to inhabit. This should be unique by type. (Lungs, Appendix, Stomach, etc)

var
sprite_datum
– /datum/sprite_accessory

Sprite datum we use to draw on the bodypart

var
stored_feature_id
–

Stores the dna.features[feature_key], used for external organs that can be surgically removed or inserted.

var
time_of_death
–

The world.time of this organ's death

var
useable
–

When you take a bite you cant jam it in for surgery anymore.

var
visual
–

Do we effect the appearance of our mob. Used to save time in preference code

var
zone
–

The body zone this organ is supposed to inhabit.

Proc Details

proc
PreRevivalInsertion
(special)

processing_organs must ALWAYS be ordered in the same way as organ_process_order Otherwise life processing breaks down

proc
add_organ_trait
(trait)

Add a trait to an organ that it will give its owner.

proc
applyOrganDamage
(damage_amount, maximum, silent, updating_health, cause_of_death)

Adjusts an organ's damage by the amount "damage_amount", up to a maximum amount, which is by default max damage

proc
attempt_vital_organ_revival
(/mob/living/carbon/human/owner)

Called by Insert() if the organ is vital and the target is dead.

proc
before_organ_replacement
(/obj/item/organ/replacement)

Called before organs are replaced in regenerate_organs with new ones

proc
build_cache_key
()

Generate a unique key based on our sprites. So that if we've aleady drawn these sprites, they can be found in the cache and wont have to be drawn again (blessing and curse)

proc
build_overlays
(physique, image_dir)

Build overlays

proc
can_draw_on_bodypart
(/mob/living/carbon/human/human)

Check whether we can draw the overlays. You generally don't want lizard snouts to draw over an EVA suit

proc
can_recover
()

Can this organ be revived from the dead?

proc
check_damage_thresholds
(/mob/organ_owner)

check_damage_thresholds
input: mob/organ_owner (a mob, the owner of the organ we call the proc on)
output: returns a message should get displayed.
description: By checking our current damage against our previous damage, we can decide whether we've passed an organ threshold.
If we have, send the corresponding threshold message to the owner, if such a message exists.

proc
check_failing_thresholds
(revivable, cause_of_death)

Checks if an organ should/shouldn't be failing and gives the appropriate organ flag

proc
cut_away
()

Cut an organ away from it's container, but do not remove it from the container physically.

↑
ex_act
(severity, target)

A little hack to ensure old behavior.

proc
exit_wardrobe
()

Used as callbacks by object pooling

proc
get_availability
(/datum/species/owner_species)

get_availability
returns whether the species should innately have this organ.
regenerate organs works with generic organs, so we need to get whether it can accept certain organs just by what this returns.
This is set to return true or false, depending on if a species has a specific organless trait. stomach for example checks if the species has NOSTOMACH and return based on that.
Arguments:
owner_species - species, needed to return whether the species has an organ specific trait

proc
get_global_feature_list
()

Return a dumb glob list for this specific feature (called from parse_sprite)

proc
get_overlays
(physique, image_dir)

Add the overlays we need to draw on a person. Called from _bodyparts.dm

proc
get_scan_results
(tag)

Called by medical scanners to get a simple summary of how healthy the organ is. Returns an empty string if things are fine.

proc
inherit_color
(force)

Give the organ it's color. Force will override the existing one.

proc
mutate_feature
(features, /mob/living/carbon/human/human)

Update our features after something changed our appearance

proc
on_death
(delta_time, times_fired)

This is on_life() but for when the organ is dead or outside of a mob. Bad name.

proc
on_life
(delta_time, times_fired)

Called once every life tick on every organ in a carbon's body NOTE: THIS IS VERY HOT. Be careful what you put in here To give you some scale, if there's 100 carbons in the game, they each have maybe 9 organs So that's 900 calls to this proc every life process. Please don't be dumb Return TRUE to call updatehealth(). Please only call inside of on_life() if it's important.

proc
override_color
(rgb_value)

Colorizes the limb it's inserted to, if required.

proc
remove_organ_trait
(trait)

Removes a trait from an organ, and by extension, its owner.

proc
setOrganDamage
(damage_amount)

SETS an organ's damage to the amount "damage_amount", and in doing so clears or sets the failing flag, good for when you have an effect that should fix an organ if broken

proc
set_organ_dead
(failing, cause_of_death)

Set or unset the organ as failing. Returns TRUE on success.

proc
set_sprite
(sprite_name)

System for drawing organs with overlays. These overlays are drawn directly on the bodypart, attached to a person or not Works in tandem with the /datum/sprite_accessory datum to generate sprites Unlike normal organs, we're actually inside a persons limbs at all times

mob_sprite is optional if you havent set sprite_datums for the object, and is used mostly to generate sprite_datums from a persons DNA For _mob_sprite we make a distinction between "Round Snout" and "round". Round Snout is the name of the sprite datum, while "round" would be part of the sprite I'm sorry

proc
surgically_fix
(/mob/user)

Used for the fix_organ surgery, lops off some of the maxHealth if the organ was very damaged.

proc
update_organ_traits
()

Updates the traits of the organ on the specific organ it is called on. Should be called anytime an organ is given a trait while it is already in a body.

organ /obj/item/organ

Vars

Procs

Var Details

var color_source –

var cosmetic_only –

var damage –

var dna_block –

var draw_color –

var external_bodytypes –

var external_damage_modifier –

var feature_key –

var layers – /list

var mutcolor_index –

var mutcolor_used –

var mutcolors – /list

var organ_traits – /list

var owner – /mob/living/carbon

var ownerlimb – /obj/item/bodypart

var preference –

var prev_damage –

var reagent_vol –

var relative_size –

var render_key –

var severe_cooldown –

var slot –

var sprite_datum – /datum/sprite_accessory

var stored_feature_id –

var time_of_death –

var useable –

var visual –

var zone –

Proc Details

proc PreRevivalInsertion(special)

proc add_organ_trait(trait)

proc applyOrganDamage(damage_amount, maximum, silent, updating_health, cause_of_death)

proc attempt_vital_organ_revival(/mob/living/carbon/human/owner)

proc before_organ_replacement(/obj/item/organ/replacement)

proc build_cache_key()

proc build_overlays(physique, image_dir)

proc can_draw_on_bodypart(/mob/living/carbon/human/human)

proc can_recover()

proc check_damage_thresholds(/mob/organ_owner)

proc check_failing_thresholds(revivable, cause_of_death)

proc cut_away()

↑ex_act(severity, target)

proc exit_wardrobe()

proc get_availability(/datum/species/owner_species)

proc get_global_feature_list()

proc get_overlays(physique, image_dir)

proc get_scan_results(tag)

proc inherit_color(force)

proc mutate_feature(features, /mob/living/carbon/human/human)

proc on_death(delta_time, times_fired)

proc on_life(delta_time, times_fired)

proc override_color(rgb_value)

proc remove_organ_trait(trait)

proc setOrganDamage(damage_amount)

proc set_organ_dead(failing, cause_of_death)

proc set_sprite(sprite_name)

proc surgically_fix(/mob/user)

proc update_organ_traits()