atom_skin

Atom skin singleton datum

Simple datum which holds information about a skin that can be applied to an atom.

Vars
allow_all_subtypes_in_loadout	When set true, will allow concrete subtypes of abstract subtypes (such as for organizational purposes) to be selectable as reskins in the loadout menu.
change_base_icon_state	If true, changing the reskin also changes the base_icon_state of the atom
change_inhand_icon_state	If true, changing the reskin also changes the inhand_icon_state of the atom
greyscale_colors	Auto populated. The greyscale_colors from greyscale_item_path.
greyscale_config	Auto populated. The greyscale_config from greyscale_item_path.
greyscale_item_path	Mandatory for GAGs items. The path to the greyscale item this is to be applied to.
new_desc	Optional, description to change the atom to when applied
new_icon	Optional, icon to change the atom to when applied
new_icon_state	Optional, icon_state to change the atom to when applied
new_inhand_icon_state	Specifies the icon state for the atom's appearance in hand. Should appear in both new_lefthand_file and new_righthand_file.
new_lefthand_file	Optional, specifies the left hand inhand icon file. Don't forget to set the right hand file as well.
new_name	Optional, name to change the atom to when applied
new_righthand_file	Optional, specifies the right hand inhand icon file. Don't forget to set the left hand file as well.
new_worn_icon	Optional, specifies the worn icon file.
preview_name	Required, name shown in the radial menu
reset_missing	If true, unset vars are reset to their original values when applying this skin
Procs
apply	Applies all relevant skin changes to the given atom Can be overridden to add additional behavior, such as registering signals or altering other vars.
clear_skin	Resets all changes this skin would have made to the given atom Does not verify that the skin was actually applied to the atom beforehand. Can be overridden to add additional behavior, such as unregistering signals or altering other vars.
get_preview_icon	Gets a preview image for this skin based on the given atom's icon and icon_state
get_preview_icon_state	Returns the correct preview icon state for this atom skin, whether it be a map_preview or a normal icon. This is assumed from our var population above.

Var Details

var
allow_all_subtypes_in_loadout

When set true, will allow concrete subtypes of abstract subtypes (such as for organizational purposes) to be selectable as reskins in the loadout menu.

var
change_base_icon_state

If true, changing the reskin also changes the base_icon_state of the atom

var
change_inhand_icon_state

If true, changing the reskin also changes the inhand_icon_state of the atom

var
greyscale_colors
– /final

Auto populated. The greyscale_colors from greyscale_item_path.

var
greyscale_config
– /final

Auto populated. The greyscale_config from greyscale_item_path.

var
greyscale_item_path
– /atom

Mandatory for GAGs items. The path to the greyscale item this is to be applied to.

var
new_desc

Optional, description to change the atom to when applied

var
new_icon

Optional, icon to change the atom to when applied

var
new_icon_state

Optional, icon_state to change the atom to when applied

var
new_inhand_icon_state

Specifies the icon state for the atom's appearance in hand. Should appear in both new_lefthand_file and new_righthand_file.

var
new_lefthand_file

Optional, specifies the left hand inhand icon file. Don't forget to set the right hand file as well.

var
new_name

Optional, name to change the atom to when applied

var
new_righthand_file

Optional, specifies the right hand inhand icon file. Don't forget to set the left hand file as well.

var
new_worn_icon

Optional, specifies the worn icon file.

var
preview_name

Required, name shown in the radial menu

var
reset_missing

If true, unset vars are reset to their original values when applying this skin

Proc Details

proc
apply
(/atom/apply_to, /mob/user)

Applies all relevant skin changes to the given atom Can be overridden to add additional behavior, such as registering signals or altering other vars.

apply_to: The atom to apply the skin to

proc
clear_skin
(/atom/clear_from, /mob/user)

Resets all changes this skin would have made to the given atom Does not verify that the skin was actually applied to the atom beforehand. Can be overridden to add additional behavior, such as unregistering signals or altering other vars.

clear_from: The atom to clear the skin from

proc
get_preview_icon
(/atom/for_atom)

Gets a preview image for this skin based on the given atom's icon and icon_state

proc
get_preview_icon_state
()

Returns the correct preview icon state for this atom skin, whether it be a map_preview or a normal icon. This is assumed from our var population above.

atom_skin /datum/atom_skin

Atom skin singleton datum

Vars

Procs

Var Details

var allow_all_subtypes_in_loadout

var change_base_icon_state

var change_inhand_icon_state

var greyscale_colors – /final

var greyscale_config – /final

var greyscale_item_path – /atom

var new_desc

var new_icon

var new_icon_state

var new_inhand_icon_state

var new_lefthand_file

var new_name

var new_righthand_file

var new_worn_icon

var preview_name

var reset_missing