/datum/mutantrace

Vars
AH	The mutant's own appearanceholder, modified to suit our target appearance
aquaphobic	Takes burn damage and hygiene loss on contact with water
aquatic	ignores suffocation from being underwater + moves at full speed underwater
can_walk_on_shards	Should they be able to walk on shards barefoot
clothing_icon_states	list of the icon states for each icon file, put here because for some ungodly reason `icon_states()` can take 200ms randomly
clothing_icons	icon definitions for mutantrace clothing variants. one icon file per slot.
color_channel_names	List of 0 to 3 strings representing the names for the color channels used in the character creator. For vanilla humans (or HAS_HUMAN_HAIR) this is list("Bottom Detail", "Mid Detail", "Top Detail").
detail_1_icon	These details will show up layered just in front of the mob's skin The image to be inserted into the mob's appearanceholder's mob_detail_1
detail_oversuit_1_icon	These details will show up layered between the backpack and the outer suit The image to be inserted into the mob's appearanceholder's mob_oversuit_1 Will only show up if the mob's appearance flag includes HAS_O
dna_mutagen_banned	Should stable mutagen not copy from this mutant?
exclusive_language	if TRUE, only understood by others of this mutantrace
eye_icon	The icon used to render their eyes
eye_offset	affects pixel_y of eyes if they're different from normal head-placement. darn anime monkey eyes If 0, it inherits that of the head offset. Otherwise, it applies as normal So, it should typically be something like head_offset +/- a few pixels
eye_state	The state used to render their eyes
genetics_removable	Should a genetics terminal be able to remove this mutantrace?
human_compatible	if TRUE, allows human diseases and dna injectors to affect this mutantrace
icon	This is used for static icons if the mutant isn't built from pieces For chunked mutantraces this must still point to a valid full-body image to generate a staticky sprite for ghostdrones.
icon_states	The icon states of the above icon, cached because byond is bad
ignore_missing_limbs	Replace both arms regardless of mob status (new and dispose).
jerk	Should robots arrest these by default?
leg_offset	affects pixel_y of the legs and stump, in case the mutant has a non-human length torsocrotch
mutant_appearance_flags
mutant_folder	The icon of the head, body, and limbs we're using
mutant_organs	Swaps out the entries in the mob's organ_holder with these (hopefully) organs Format: ("entry_in_organholder's_organlist", /obj/item/organ/path)
mutant_organs_f	If our mutant has a female variant that has different organs, these will be used instead
override_eyes	The mutant's original appearanceholder, from before they were a mutant, to restore their old appearance
override_limb_icons	If true, normal limbs use custom icons for this mutantrace
race_mutation	The mutation associted with the mutantrace. Saurian genetics for lizards, for instance
special_hair_1_color	Which preference entry to colorize this from. CUST_1 to use the appearanceholder's custom_first_color, and so on. Make null for just "#FFFFFF"
special_hair_1_icon	Special Hair is anything additional that's supposed to be stuck to the mob's head Can be anything, honestly. Used for lizard head things and cow horns Will only show up if the mob's appearance flag includes HAS_SPECIAL_HAIR
special_hair_1_icon_f	The "_f" vars are applied for female variants, if the appearance flags don't have NOT_DIMORPHIC
special_hair_1_layer	Which layer should this hair appear? Defaults to the normal hair-layer
special_hair_1_state	State to be used. Human hairstyles must be defined by their icon state, not hairstyle name!
special_hair_2_icon	The image to be inserted into the mob's appearanceholder's customization_second
special_hair_3_icon	The image to be inserted into the mob's appearanceholder's customization_third
special_head	If the mutant uses a non-human head, this'll tell the head builder which head to build
special_head_f	If our mutant has a female variant, it'll use this head instead
special_head_state	The icon_state of the head we're using
special_head_state_f	If our mutant has a female variant, it'll use this head image instead
typeinfo_type	mutant races: cheap way to add new "types" of mobs
uses_human_clothes	if FALSE, can only wear clothes if listed in /obj/item/clothing/var/compatible_species
voice_message	overrides normal voice message if defined (and others don't understand us, ofc)
Procs
MakeMutantDimorphic	Copies over female variants of mutant heads and organs
MutateMutant	Applies or removes the bioeffect associated with the mutantrace
apply_clothing_filters	Called by /mob/living/carbon/human/update_clothing()'s slot-specific sub-procs. Each sub-proc passes its obj to this proc, which you can then operate on. Should return a filter or list of filters, to be added to the obj's wear_image.filters
load_clothing_icons	Load all the clothing override icons, should call parent AFTER populating `clothing_icons`
onDeath	Called when our mob dies. Returning a true value will short circuit the normal death proc right before deathgasp/headspider/etc Rturn values are [MUTRACE_ONDEATH_NOTHING], [MUTRACE_ONDEATH_REVIVED], [MUTRACE_ONDEATH_DEFER_DELETE] etc.
on_attach	For calling of procs when a mob is given a mutant race, to avoid issues with abstract representation in on_attach()
organ_mutator	ARMS LEGS HEAD LEGS HEAD

Var Details

var
AH
– /datum/appearanceHolder

The mutant's own appearanceholder, modified to suit our target appearance

var
aquaphobic
–

Takes burn damage and hygiene loss on contact with water

var
aquatic
–

ignores suffocation from being underwater + moves at full speed underwater

var
can_walk_on_shards
–

Should they be able to walk on shards barefoot

var
clothing_icon_states
–

list of the icon states for each icon file, put here because for some ungodly reason icon_states() can take 200ms randomly

var
clothing_icons
–

icon definitions for mutantrace clothing variants. one icon file per slot.

var
color_channel_names
– /list

List of 0 to 3 strings representing the names for the color channels used in the character creator. For vanilla humans (or HAS_HUMAN_HAIR) this is list("Bottom Detail", "Mid Detail", "Top Detail").

var
detail_1_icon
–

These details will show up layered just in front of the mob's skin The image to be inserted into the mob's appearanceholder's mob_detail_1

var
detail_oversuit_1_icon
–

These details will show up layered between the backpack and the outer suit The image to be inserted into the mob's appearanceholder's mob_oversuit_1 Will only show up if the mob's appearance flag includes HAS_O

var
dna_mutagen_banned
–

Should stable mutagen not copy from this mutant?

var
exclusive_language
–

if TRUE, only understood by others of this mutantrace

var
eye_icon
–

The icon used to render their eyes

var
eye_offset
–

affects pixel_y of eyes if they're different from normal head-placement. darn anime monkey eyes If 0, it inherits that of the head offset. Otherwise, it applies as normal So, it should typically be something like head_offset +/- a few pixels

var
eye_state
–

The state used to render their eyes

var
genetics_removable
–

Should a genetics terminal be able to remove this mutantrace?

var
human_compatible
–

if TRUE, allows human diseases and dna injectors to affect this mutantrace

var
icon
–

This is used for static icons if the mutant isn't built from pieces For chunked mutantraces this must still point to a valid full-body image to generate a staticky sprite for ghostdrones.

var
icon_states
–

The icon states of the above icon, cached because byond is bad

var
ignore_missing_limbs
–

Replace both arms regardless of mob status (new and dispose).

var
jerk
–

Should robots arrest these by default?

var
leg_offset
–

affects pixel_y of the legs and stump, in case the mutant has a non-human length torsocrotch

var
mutant_appearance_flags
–

Mutant Appearance Flags - used to modify how the mob is drawn
- For a purely static-icon mutantrace (drawn from a single, non-chunked image), use:
- (NOT_DIMORPHIC | HAS_NO_SKINTONE | HAS_NO_EYES | HAS_NO_HEAD | USES_STATIC_ICON)
- NOT_DIMORPHIC tells the sprite builder not to use any female sprites or vars. If you remove this, make sure there's a chest_f and groin_f in the mutant's DMI!
- HAS_NO_SKINTONE, HAS_NO_EYES, HAS_NO_HEAD each prevent the renderer from trying to colorize the player's body or apply hair / eyes. They tend to be baked in.
- USES_STATIC_IMAGE tells the renderer to skip most of the body-sprite assembly stuff, since our sprite is already fully assembled
- To make a dismemberable mutant, here's an example from lizard:
- (NOT_DIMORPHIC | HAS_HUMAN_EYES | BUILT_FROM_PIECES | HAS_EXTRA_DETAILS | FIX_COLORS | SKINTONE_USES_PREF_COLOR_1 | HAS_SPECIAL_HAIR)
- SKINTONE_USES_PREF_COLOR_1 tells the renderer that the skintone will come from the appearanceholder's first customization color
- HAS_HUMAN_EYES tells the head builder to render their eyes
- HAS_EXTRA_DETAILS tells the sprite builder to apply whatever's defined in their mob_detail_1 vars to their sprite
- FIX_COLORS clamps the RGB values of the customization colors betwen 50 and 190. Keeps them from getting too dark or oversaturated
- HAS_SPECIAL_HAIR tells the hair renderer to display the sprites stored iin the head's special hair, which can be defined here (through the appearanceholder)
- BUILT_FROM_PIECES is important, it tells the renderer to assemble the mutant from a set of separate pieces, like a human
- this allows them to apppear to be missing limbs when dismembered. Check out lizard.dmi for an example of how it should be set up.
- SEE: appearance.dm for more flags and details!

var
mutant_folder
–

The icon of the head, body, and limbs we're using

var
mutant_organs
– /list

Swaps out the entries in the mob's organ_holder with these (hopefully) organs Format: ("entry_in_organholder's_organlist", /obj/item/organ/path)

var
mutant_organs_f
– /list

If our mutant has a female variant that has different organs, these will be used instead

var
override_eyes
–

The mutant's original appearanceholder, from before they were a mutant, to restore their old appearance

var
override_limb_icons
–

If true, normal limbs use custom icons for this mutantrace

var
race_mutation
–

The mutation associted with the mutantrace. Saurian genetics for lizards, for instance

var
special_hair_1_color
–

Which preference entry to colorize this from. CUST_1 to use the appearanceholder's custom_first_color, and so on. Make null for just "#FFFFFF"

var
special_hair_1_icon
–

Special Hair is anything additional that's supposed to be stuck to the mob's head Can be anything, honestly. Used for lizard head things and cow horns Will only show up if the mob's appearance flag includes HAS_SPECIAL_HAIR

var
special_hair_1_icon_f
–

The "_f" vars are applied for female variants, if the appearance flags don't have NOT_DIMORPHIC

var
special_hair_1_layer
–

Which layer should this hair appear? Defaults to the normal hair-layer

var
special_hair_1_state
–

State to be used. Human hairstyles must be defined by their icon state, not hairstyle name!

var
special_hair_2_icon
–

The image to be inserted into the mob's appearanceholder's customization_second

var
special_hair_3_icon
–

The image to be inserted into the mob's appearanceholder's customization_third

var
special_head
–

If the mutant uses a non-human head, this'll tell the head builder which head to build

var
special_head_f
–

If our mutant has a female variant, it'll use this head instead

var
special_head_state
–

The icon_state of the head we're using

var
special_head_state_f
–

If our mutant has a female variant, it'll use this head image instead

typeinfo_type
–

mutant races: cheap way to add new "types" of mobs

var
uses_human_clothes
–

if FALSE, can only wear clothes if listed in /obj/item/clothing/var/compatible_species

var
voice_message
–

overrides normal voice message if defined (and others don't understand us, ofc)

Proc Details

proc
MakeMutantDimorphic
(/mob/living/carbon/human/H)

Copies over female variants of mutant heads and organs

proc
MutateMutant
(/mob/living/carbon/human/H)

Applies or removes the bioeffect associated with the mutantrace

proc
apply_clothing_filters
(/obj/item/worn)

Called by /mob/living/carbon/human/update_clothing()'s slot-specific sub-procs. Each sub-proc passes its obj to this proc, which you can then operate on. Should return a filter or list of filters, to be added to the obj's wear_image.filters

proc
load_clothing_icons
()

Load all the clothing override icons, should call parent AFTER populating clothing_icons

proc
onDeath
(gibbed)

Called when our mob dies. Returning a true value will short circuit the normal death proc right before deathgasp/headspider/etc Rturn values are [MUTRACE_ONDEATH_NOTHING], [MUTRACE_ONDEATH_REVIVED], [MUTRACE_ONDEATH_DEFER_DELETE] etc.

proc
on_attach
(/mob/living/carbon/human/M)

For calling of procs when a mob is given a mutant race, to avoid issues with abstract representation in on_attach()

proc
organ_mutator
(/mob/living/carbon/human/O, mode)

ARMS LEGS HEAD LEGS HEAD

/datum/mutantrace

Vars

Procs

Var Details

var AH – /datum/appearanceHolder

var aquaphobic –

var aquatic –

var can_walk_on_shards –

var clothing_icon_states –

var clothing_icons –

var color_channel_names – /list

var detail_1_icon –

var detail_oversuit_1_icon –

var dna_mutagen_banned –

var exclusive_language –

var eye_icon –

var eye_offset –

var eye_state –

var genetics_removable –

var human_compatible –

var icon –

var icon_states –

var ignore_missing_limbs –

var jerk –

var leg_offset –

var mutant_appearance_flags –

var mutant_folder –

var mutant_organs – /list

var mutant_organs_f – /list

var override_eyes –

var override_limb_icons –

var race_mutation –

var special_hair_1_color –

var special_hair_1_icon –

var special_hair_1_icon_f –

var special_hair_1_layer –

var special_hair_1_state –

var special_hair_2_icon –

var special_hair_3_icon –

var special_head –

var special_head_f –

var special_head_state –

var special_head_state_f –

typeinfo_type –

var uses_human_clothes –

var voice_message –