sprite_accessory

Vars
always_color_customizable	Set this to true to make an accessory appear as color customizable in preferences despite advanced color settings being off, will also prevent the accessory from being reset
center	Should we center the sprite?
default_color	Which color we default to on acquisition of the accessory (such as switching species, default color for character customization etc) You can also put down a a HEX color, to be used instead as the default
dimension_x	The width of the sprite in pixels. Used to center it if necessary.
dimension_y	The height of the sprite in pixels. Used to center it if necessary.
em_block	Should this sprite block emissives?
emissive_layers	a list of layers which render an extra emissive overlay
erp_accessory	If this sprite accessory will be inaccessable if ERP config is disabled
factual	This is used to determine whether an accessory gets added to someone. This is important for accessories that are "None", which should have this set to false
flags_for_organ	For all the flags that you need to pass from a sprite_accessory to an organ, when it's linked to one. (i.e. passing through the fact that a snout should or shouldn't use a muzzled sprite for head worn items)
gender	Determines if the accessory will be skipped or included in random hair generations.
gender_specific	Something that can be worn by either gender, but looks different on each.
has_inner	Whether or not this sprite accessory has an additional overlay added to it as an "inner" part, which is pre-colored.
icon	The icon file the accessory is located in.
icon_state	The icon_state of the accessory.
key	Unique key of an accessory. All tails should have FEATURE_TAIL, ears FEATURE_EARS etc.
locked	Is this part locked from roundstart selection? Used for parts that apply effects.
mod_icon_slots	All of these inventory slots must contain sealed parts of the wearer's MOD to project hardlight. NONE disables it.
name	The preview name of the accessory.
natural_spawn	Determines if this is considered "sane" for the purpose of /proc/randomize_human_normie Basically this is to blacklist the extremely wacky stuff from being picked in random human generation.
organ_type	Use this as a type path to an organ that this sprite_accessory will be associated. Make sure the organ has 'mutantpart_info' set properly.
special	If an accessory is special, it wont get included in the normal accessory lists
special_x_dimension	Special case of whether the accessory should be shifted in the X dimension, check taur genitals for example
use_static	Determines if the accessory will be skipped by color preferences.
Procs
get_custom_mod_icon	Returns a shared icon resource. The caller resolves the active theme once for all color layers.
get_hardlight_theme_key	The hardlight theme string, for use in the render cache key - so we don't get any color collisions
get_mod_overlay_theme	Resolve both eligibility and color from the same suit, including during partial activation and rollback.
get_sprite_suffix	Returns the 'suffix' of the sprite (by default just the icon_state)

Var Details

var
always_color_customizable

Set this to true to make an accessory appear as color customizable in preferences despite advanced color settings being off, will also prevent the accessory from being reset

var
center

Should we center the sprite?

var
default_color

Which color we default to on acquisition of the accessory (such as switching species, default color for character customization etc) You can also put down a a HEX color, to be used instead as the default

var
dimension_x

The width of the sprite in pixels. Used to center it if necessary.

var
dimension_y

The height of the sprite in pixels. Used to center it if necessary.

var
em_block

Should this sprite block emissives?

var
emissive_layers
– /list

a list of layers which render an extra emissive overlay

var
erp_accessory

If this sprite accessory will be inaccessable if ERP config is disabled

var
factual

This is used to determine whether an accessory gets added to someone. This is important for accessories that are "None", which should have this set to false

var
flags_for_organ

For all the flags that you need to pass from a sprite_accessory to an organ, when it's linked to one. (i.e. passing through the fact that a snout should or shouldn't use a muzzled sprite for head worn items)

var
gender

Determines if the accessory will be skipped or included in random hair generations.

var
gender_specific

Something that can be worn by either gender, but looks different on each.

var
has_inner

Whether or not this sprite accessory has an additional overlay added to it as an "inner" part, which is pre-colored.

var
icon

The icon file the accessory is located in.

var
icon_state

The icon_state of the accessory.

var
key

Unique key of an accessory. All tails should have FEATURE_TAIL, ears FEATURE_EARS etc.

var
locked

Is this part locked from roundstart selection? Used for parts that apply effects.

var
mod_icon_slots

All of these inventory slots must contain sealed parts of the wearer's MOD to project hardlight. NONE disables it.

var
name

The preview name of the accessory.

var
natural_spawn

Determines if this is considered "sane" for the purpose of /proc/randomize_human_normie Basically this is to blacklist the extremely wacky stuff from being picked in random human generation.

var
organ_type
– /obj/item/organ

Use this as a type path to an organ that this sprite_accessory will be associated. Make sure the organ has 'mutantpart_info' set properly.

var
special

If an accessory is special, it wont get included in the normal accessory lists

var
special_x_dimension

Special case of whether the accessory should be shifted in the X dimension, check taur genitals for example

var
use_static

Determines if the accessory will be skipped by color preferences.

Proc Details

proc
get_custom_mod_icon
(/mutable_appearance/appearance_to_use, /datum/mod_theme/mod_theme)

Returns a shared icon resource. The caller resolves the active theme once for all color layers.

proc
get_hardlight_theme_key
(/mob/living/carbon/human/wearer)

The hardlight theme string, for use in the render cache key - so we don't get any color collisions

proc
get_mod_overlay_theme
(/mob/living/carbon/human/wearer) as /datum/mod_theme

Resolve both eligibility and color from the same suit, including during partial activation and rollback.

proc
get_sprite_suffix
()

Returns the 'suffix' of the sprite (by default just the icon_state)

sprite_accessory /datum/sprite_accessory

Vars

Procs

Var Details

var always_color_customizable

var center

var default_color

var dimension_x

var dimension_y

var em_block

var emissive_layers – /list

var erp_accessory

var factual

var flags_for_organ

var gender

var gender_specific

var has_inner

var icon

var icon_state

var key

var locked

var mod_icon_slots

var name

var natural_spawn

var organ_type – /obj/item/organ

var special

var special_x_dimension

var use_static