paintable_decal_category

Paintable Decal Category

Holds a bunch of information the decal painter uses to determine what it can and can't paint, and how to paint it.

Vars
cached_category_data	Caches UI data to avoid regenerating it every time. It doesn't change anyways
category	Human readable category name
default_alpha	Alpha for decals painted from this category (assuming no custom color is used)
dir_list	Direction options for this category - formatted as readable label - dir value to return
paintable_decal_type	The type of paintable decal this category contains - should be a subtype of /datum/paintable_decal
possible_colors	Color options for this category - formatted as readable label - color value
preview_floor_icon	Icon used for previews
preview_floor_state	Icon state used for previews
Procs
generate_all_spritesheet_icons	Returns a list of preview icons for every single variety of every decal in this category for use in a spritesheet
generate_colored_decal_spritesheet_icon	Actually generates the preview icon for a specific decal state, direction, and color
generate_independent_decal_spritesheet_icons	Returns a list of preview icon for a specific decal state and direction
get_decal_info	Used by the decal painter to modify the state of the decal based on the... state.
get_ui_data	Constructs and returns this category's UI data
is_color_valid	Checks if the passed color is one of this category's colors
is_dir_valid	Checks if the passed direction is one of this category's directions
is_state_valid	Checks if the passed icon state is one of this category's decals
spritesheet_key	Returns a key for the spritesheet icon, used to avoid duplicates

Var Details

var
cached_category_data
– /list

Caches UI data to avoid regenerating it every time. It doesn't change anyways

var
category

Human readable category name

var
default_alpha

Alpha for decals painted from this category (assuming no custom color is used)

var
dir_list
– /list

Direction options for this category - formatted as readable label - dir value to return

var
paintable_decal_type

The type of paintable decal this category contains - should be a subtype of /datum/paintable_decal

var
possible_colors
– /list

Color options for this category - formatted as readable label - color value

var
preview_floor_icon

Icon used for previews

var
preview_floor_state

Icon state used for previews

Proc Details

proc
generate_all_spritesheet_icons
()

Returns a list of preview icons for every single variety of every decal in this category for use in a spritesheet

proc
generate_colored_decal_spritesheet_icon
(state, dir, color)

Actually generates the preview icon for a specific decal state, direction, and color

proc
generate_independent_decal_spritesheet_icons
(dir, state)

Returns a list of preview icon for a specific decal state and direction

proc
get_decal_info
(state, color, dir)

Used by the decal painter to modify the state of the decal based on the... state.

proc
get_ui_data
() as /list

Constructs and returns this category's UI data

proc
is_color_valid
(color)

Checks if the passed color is one of this category's colors

proc
is_dir_valid
(dir)

Checks if the passed direction is one of this category's directions

proc
is_state_valid
(state)

Checks if the passed icon state is one of this category's decals

proc
spritesheet_key
(dir, state, color)

Returns a key for the spritesheet icon, used to avoid duplicates

paintable_decal_category /datum/paintable_decal_category