head

Vars
can_dismember	Can this head be dismembered normally?
custom_facial_hair	This owner's facial hair drawing; DNA and head snapshots are copied independently.
custom_hair	This owner's hair drawing; DNA and head snapshots are copied independently.
eyes_icon	Override of the eyes icon file, used for Vox and maybe more in the future - The future is now, with Teshari using it too
facial_hair_alpha	Facial hair alpha
facial_hair_color	Facial hair color
facial_hairstyle	Facial hair style
fixed_hair_color	An override that cannot be cleared under any circumstances, affects both hair and facial hair
gradient_colors	Gradient colors, if any
gradient_styles	Gradient styles, if any
hair_alpha	Hair alpha
hair_color	Hair colour and style
hairstyle	Hair style
head_flags	Flags related to appearance, such as hair, lips, etc
lip_color	Lipstick color
lip_style	Type of lipstick being used, basically
override_hair_color	An override color that can be cleared later, affects both hair and facial hair
real_name	Replacement name
show_organs_on_examine	Do we show the information about missing organs upon being examined? Defaults to TRUE, useful for Dullahan heads.
stored_lipstick_trait	Current lipstick trait, if any (such as TRAIT_KISS_OF_DEATH)
teeth_count	How many teeth the head's species has, humans have 32 so that's the default. Used for a limit to dental pill implants.
worn_ears_offset	Offset to apply to equipment worn on the ears
worn_face_offset	Offset to apply to overlays placed on the face
worn_glasses_offset	Offset to apply to equipment worn on the eyes
worn_head_offset	Offset to apply to equipment worn on the head
worn_mask_offset	Offset to apply to equipment worn on the mouth
Procs
append_custom_appendage_overlays	Adds each appendage after the hair's paint: under-hat pieces on the hair layer, over-hat pieces above headwear.
append_custom_hair_paint_overlays	Adds the painted layer for one head target to `hair_overlays`: its blocker, the tinted paint (with its gradient), then its glow. Hair's appendages follow.
append_custom_paint_image	Adds one painted layer to `hair_overlays` where the head draws it: its blocker mask, the paint and its gradient, then its glow mask.
custom_appendage_masks	The worn hair masks that trim an appendage, or null when they hide it.
custom_head_drawing	The drawing this head carries for one head target.
custom_sprite_copy_base_hair	Captures native hair alone before its live gradient and opacity, on a private editor head only.
custom_sprite_facial_hair_accessory	The accessory this head's facial hair draws with: the real one, or the nameless blank so a shaved face can carry paint.
custom_sprite_hair_accessory	The accessory this head's hair draws with: the real one, or the nameless blank so a bald head can carry paint.
get_base_facial_hair_overlays	Used in constructing the hair overlays - handles just facial hair
get_base_hair_overlays	Used in constructing the hair overlays - handles just the hair on top of the head
get_custom_hair_paint	Each head gets a private masked copy; the shared accessory cache is never painted.
get_debrain_overlay	Returns an appropriate debrained overlay
get_eye_overlays	Returns a list of all eye related overlays, or an eyeless overlay if applicable
get_eyeless_overlay	Returns an appropriate missing eyes overlay
get_gradient_overlay	Returns an appropriate hair/facial hair gradient overlay
get_hair_gradient_color	Get the hair gradient color of a head. Defaults to black.
get_hair_gradient_style	Get the hair gradient style of a head. Defaults to "None". arguments:
get_hair_overlays	Returns a list of all hair/facial hair related overlays, or alternatively the debrained overlay if applicable
get_lips_overlays	Returns a list of all overlays associated with the lips
get_rendered_hair_color	Resolves the colour this head's hair actually renders in.
set_custom_head_drawing	Replaces the drawing this head carries for one head target.
set_overlay_hair_color	Helper for setting hair color of an overlay appropriately

Var Details

var
can_dismember

Can this head be dismembered normally?

var
custom_facial_hair
– /list

This owner's facial hair drawing; DNA and head snapshots are copied independently.

var
custom_hair
– /list

This owner's hair drawing; DNA and head snapshots are copied independently.

var
eyes_icon

Override of the eyes icon file, used for Vox and maybe more in the future - The future is now, with Teshari using it too

var
facial_hair_alpha

Facial hair alpha

var
facial_hair_color

Facial hair color

var
facial_hairstyle

Facial hair style

var
fixed_hair_color

An override that cannot be cleared under any circumstances, affects both hair and facial hair

var
gradient_colors
– /list

Gradient colors, if any

var
gradient_styles
– /list

Gradient styles, if any

var
hair_alpha

Hair alpha

var
hair_color

Hair colour and style

var
hairstyle

Hair style

var
head_flags

Flags related to appearance, such as hair, lips, etc

var
lip_color

Lipstick color

var
lip_style

Type of lipstick being used, basically

var
override_hair_color

An override color that can be cleared later, affects both hair and facial hair

var
real_name

Replacement name

var
show_organs_on_examine

Do we show the information about missing organs upon being examined? Defaults to TRUE, useful for Dullahan heads.

var
stored_lipstick_trait

Current lipstick trait, if any (such as TRAIT_KISS_OF_DEATH)

var
teeth_count

How many teeth the head's species has, humans have 32 so that's the default. Used for a limit to dental pill implants.

var
worn_ears_offset
– /datum/worn_feature_offset

Offset to apply to equipment worn on the ears

var
worn_face_offset
– /datum/worn_feature_offset

Offset to apply to overlays placed on the face

var
worn_glasses_offset
– /datum/worn_feature_offset

Offset to apply to equipment worn on the eyes

var
worn_head_offset
– /datum/worn_feature_offset

Offset to apply to equipment worn on the head

var
worn_mask_offset
– /datum/worn_feature_offset

Offset to apply to equipment worn on the mouth

Proc Details

proc
append_custom_appendage_overlays
(/list/hair_overlays, /datum/sprite_accessory/hair/hairstyle, dropped)

Adds each appendage after the hair's paint: under-hat pieces on the hair layer, over-hat pieces above headwear.

proc
append_custom_hair_paint_overlays
(/list/hair_overlays, /icon/paint, /datum/sprite_accessory/hair/hairstyle, dropped, target)

Adds the painted layer for one head target to hair_overlays: its blocker, the tinted paint (with its gradient), then its glow. Hair's appendages follow.

proc
append_custom_paint_image
(/list/hair_overlays, /icon/paint, tint, /list/emissive, layer, geometry_key, /datum/sprite_accessory/hair/hairstyle, dropped, target, merged)

Adds one painted layer to hair_overlays where the head draws it: its blocker mask, the paint and its gradient, then its glow mask.

Arguments:

tint: The drawing's colour filter. Paint without one follows the hair colour, as untinted paint merged into the hair always has.
emissive: This layer's own per-view emission settings.
layer: The paint's layer, -HAIR_LAYER or -OUTER_HAIR_LAYER.
geometry_key: Identifies the paint's pixels and trimming for the shared mask caches.
merged: The paint is already part of the hair's own image, so only its masks are added.

proc
custom_appendage_masks
(/list/appendage)

The worn hair masks that trim an appendage, or null when they hide it.

As with a hairstyle's own pieces: an under-hat piece is trimmed only by masks whose strict coverage includes its zone, and an over-hat piece is never trimmed but is left out while any worn mask strictly covers its zone.

proc
custom_head_drawing
(target)

The drawing this head carries for one head target.

proc
custom_sprite_copy_base_hair
(direction, width, height, /list/lift)

Captures native hair alone before its live gradient and opacity, on a private editor head only.

proc
custom_sprite_facial_hair_accessory
()

The accessory this head's facial hair draws with: the real one, or the nameless blank so a shaved face can carry paint.

proc
custom_sprite_hair_accessory
()

The accessory this head's hair draws with: the real one, or the nameless blank so a bald head can carry paint.

proc
get_base_facial_hair_overlays
(dropped)

Used in constructing the hair overlays - handles just facial hair

proc
get_base_hair_overlays
(dropped)

Used in constructing the hair overlays - handles just the hair on top of the head

proc
get_custom_hair_paint
(/datum/sprite_accessory/hair/hairstyle, target)

Each head gets a private masked copy; the shared accessory cache is never painted.

proc
get_debrain_overlay
(dropped) as /image

Returns an appropriate debrained overlay

proc
get_eye_overlays
(dropped)

Returns a list of all eye related overlays, or an eyeless overlay if applicable

proc
get_eyeless_overlay
(dropped) as /image

Returns an appropriate missing eyes overlay

proc
get_gradient_overlay
(/icon/base_icon, layer, /datum/sprite_accessory/gradient, grad_color, dropped) as /mutable_appearance

Returns an appropriate hair/facial hair gradient overlay

proc
get_hair_gradient_color
(key)

Get the hair gradient color of a head. Defaults to black.

arguments:

key (optional) - corresponds to hair or facial hair index. If no key is provided returns whole list.

proc
get_hair_gradient_style
(key)

Get the hair gradient style of a head. Defaults to "None". arguments:

key (optional) - corresponds to hair or facial hair index. If no key is provided returns whole list.

proc
get_hair_overlays
(dropped)

Returns a list of all hair/facial hair related overlays, or alternatively the debrained overlay if applicable

proc
get_lips_overlays
(dropped)

Returns a list of all overlays associated with the lips

proc
get_rendered_hair_color
(facial)

Resolves the colour this head's hair actually renders in.

Mirrors the precedence in /obj/item/bodypart/head/proc/set_overlay_hair_color, so trimmings match the hair they came off even when something has overridden it.

facial - read the facial hair colour instead of the scalp's.

proc
set_custom_head_drawing
(target, /list/drawing)

Replaces the drawing this head carries for one head target.

proc
set_overlay_hair_color
(/image/hair_overlay, hair_color_to_use)

Helper for setting hair color of an overlay appropriately

head /obj/item/bodypart/head

Vars

Procs

Var Details

var can_dismember

var custom_facial_hair – /list

var custom_hair – /list

var eyes_icon

var facial_hair_alpha

var facial_hair_color

var facial_hairstyle

var fixed_hair_color

var gradient_colors – /list

var gradient_styles – /list

var hair_alpha

var hair_color

var hairstyle

var head_flags

var lip_color

var lip_style

var override_hair_color

var real_name

var show_organs_on_examine

var stored_lipstick_trait

var teeth_count

var worn_ears_offset – /datum/worn_feature_offset

var worn_face_offset – /datum/worn_feature_offset

var worn_glasses_offset – /datum/worn_feature_offset

var worn_head_offset – /datum/worn_feature_offset

var worn_mask_offset – /datum/worn_feature_offset

Proc Details

proc append_custom_appendage_overlays(/list/hair_overlays, /datum/sprite_accessory/hair/hairstyle, dropped)

proc append_custom_hair_paint_overlays(/list/hair_overlays, /icon/paint, /datum/sprite_accessory/hair/hairstyle, dropped, target)

proc append_custom_paint_image(/list/hair_overlays, /icon/paint, tint, /list/emissive, layer, geometry_key, /datum/sprite_accessory/hair/hairstyle, dropped, target, merged)

proc custom_appendage_masks(/list/appendage)

proc custom_head_drawing(target)

proc custom_sprite_copy_base_hair(direction, width, height, /list/lift)

proc custom_sprite_facial_hair_accessory()

proc custom_sprite_hair_accessory()

proc get_base_facial_hair_overlays(dropped)

proc get_base_hair_overlays(dropped)

proc get_custom_hair_paint(/datum/sprite_accessory/hair/hairstyle, target)

proc get_debrain_overlay(dropped) as /image

proc get_eye_overlays(dropped)

proc get_eyeless_overlay(dropped) as /image

proc get_gradient_overlay(/icon/base_icon, layer, /datum/sprite_accessory/gradient, grad_color, dropped) as /mutable_appearance

proc get_hair_gradient_color(key)

proc get_hair_gradient_style(key)

proc get_hair_overlays(dropped)

proc get_lips_overlays(dropped)

proc get_rendered_hair_color(facial)

proc set_custom_head_drawing(target, /list/drawing)

proc set_overlay_hair_color(/image/hair_overlay, hair_color_to_use)

head
/obj/item/bodypart/head

var
can_dismember

var
custom_facial_hair
– /list

var
custom_hair
– /list

var
eyes_icon

var
facial_hair_alpha

var
facial_hair_color

var
facial_hairstyle

var
fixed_hair_color

var
gradient_colors
– /list

var
gradient_styles
– /list

var
hair_alpha

var
hair_color

var
hairstyle

var
head_flags

var
lip_color

var
lip_style

var
override_hair_color

var
real_name

var
show_organs_on_examine

var
stored_lipstick_trait

var
teeth_count

var
worn_ears_offset
– /datum/worn_feature_offset

var
worn_face_offset
– /datum/worn_feature_offset

var
worn_glasses_offset
– /datum/worn_feature_offset

var
worn_head_offset
– /datum/worn_feature_offset

var
worn_mask_offset
– /datum/worn_feature_offset

proc
append_custom_appendage_overlays
(/list/hair_overlays, /datum/sprite_accessory/hair/hairstyle, dropped)

proc
append_custom_hair_paint_overlays
(/list/hair_overlays, /icon/paint, /datum/sprite_accessory/hair/hairstyle, dropped, target)

proc
append_custom_paint_image
(/list/hair_overlays, /icon/paint, tint, /list/emissive, layer, geometry_key, /datum/sprite_accessory/hair/hairstyle, dropped, target, merged)

proc
custom_appendage_masks
(/list/appendage)

proc
custom_head_drawing
(target)

proc
custom_sprite_copy_base_hair
(direction, width, height, /list/lift)

proc
custom_sprite_facial_hair_accessory
()

proc
custom_sprite_hair_accessory
()

proc
get_base_facial_hair_overlays
(dropped)

proc
get_base_hair_overlays
(dropped)

proc
get_custom_hair_paint
(/datum/sprite_accessory/hair/hairstyle, target)

proc
get_debrain_overlay
(dropped) as /image

proc
get_eye_overlays
(dropped)

proc
get_eyeless_overlay
(dropped) as /image

proc
get_gradient_overlay
(/icon/base_icon, layer, /datum/sprite_accessory/gradient, grad_color, dropped) as /mutable_appearance

proc
get_hair_gradient_color
(key)

proc
get_hair_gradient_style
(key)

proc
get_hair_overlays
(dropped)

proc
get_lips_overlays
(dropped)

proc
get_rendered_hair_color
(facial)

proc
set_custom_head_drawing
(target, /list/drawing)

proc
set_overlay_hair_color
(/image/hair_overlay, hair_color_to_use)