/datum/greyscale_config

A datum tying together a greyscale configuration and dmi file. Required for using GAGS and handles the code interactions.

Vars
expected_colors	How many colors are expected to be given when building the sprite
flat_all_layers	A list of all layers irrespective of nesting
height	Spritesheet height of the icon_file
icon_cache	Generated icons keyed by their color arguments
icon_file	Reference to the dmi file for this config
icon_file_hash	The md5 file hash for the icon file. Used to check if the file has changed
icon_states	A list of icon states and their layers
json_config	Reference to the json config file
json_config_hash	The md5 file hash for the json configuration. Used to check if the file has changed
live_edit_types	A list of types to update in the world whenever a config changes
material_skin	An optional var to set that tells the material system what material this configuration is for. Use a typepath here, not an instance.
name	User friendly name used in the debug menu
string_icon_file	String path to the icon file, used for reloading
string_json_config	String path to the json file, used for reloading
width	Spritesheet width of the icon_file
Procs
CrossVerify	Called after every config has refreshed, this proc handles data verification that depends on multiple entwined configurations.
DebugName	Gets the name used for debug purposes
Generate	Actually create the icon and color it in, handles caching
GenerateBundle	Handles the actual icon manipulation to create the spritesheet
GenerateLayerGroup	Internal recursive proc to handle nested layer groups
ReadIconStateConfiguration	Takes the json icon state configuration and puts it into a more processed format.
ReadLayersFromJson	Takes the json layers configuration and puts it into a more processed format
ReadMetadata	Reads layer configurations to take out some useful overall information
Refresh	Call this proc to handle all the data extraction from the json configuration. Can be forced to load values from disk instead of memory.
SaveOutput	For saving a dmi to disk, useful for debug mainly

Var Details

var
expected_colors
–

How many colors are expected to be given when building the sprite

var
flat_all_layers
– /list

A list of all layers irrespective of nesting

var
height
–

Spritesheet height of the icon_file

var
icon_cache
– /list

Generated icons keyed by their color arguments

var
icon_file
–

Reference to the dmi file for this config

var
icon_file_hash
–

The md5 file hash for the icon file. Used to check if the file has changed

var
icon_states
– /list

A list of icon states and their layers

var
json_config
–

Reference to the json config file

var
json_config_hash
–

The md5 file hash for the json configuration. Used to check if the file has changed

var
live_edit_types
– /list

A list of types to update in the world whenever a config changes

var
material_skin
– /datum/material

An optional var to set that tells the material system what material this configuration is for. Use a typepath here, not an instance.

var
name
–

User friendly name used in the debug menu

var
string_icon_file
–

String path to the icon file, used for reloading

var
string_json_config
–

String path to the json file, used for reloading

var
width
–

Spritesheet width of the icon_file

Proc Details

proc
CrossVerify
()

Called after every config has refreshed, this proc handles data verification that depends on multiple entwined configurations.

proc
DebugName
()

Gets the name used for debug purposes

proc
Generate
(color_string, /icon/last_external_icon)

Actually create the icon and color it in, handles caching

proc
GenerateBundle
(/list/colors, /list/render_steps, /icon/last_external_icon)

Handles the actual icon manipulation to create the spritesheet

proc
GenerateLayerGroup
(/list/colors, /list/group, /list/render_steps, /icon/last_external_icon)

Internal recursive proc to handle nested layer groups

proc
ReadIconStateConfiguration
(/list/data)

Takes the json icon state configuration and puts it into a more processed format.

proc
ReadLayersFromJson
(/list/data)

Takes the json layers configuration and puts it into a more processed format

proc
ReadMetadata
()

Reads layer configurations to take out some useful overall information

proc
Refresh
(loadFromDisk)

Call this proc to handle all the data extraction from the json configuration. Can be forced to load values from disk instead of memory.

proc
SaveOutput
(color_string)

For saving a dmi to disk, useful for debug mainly

/datum/greyscale_config

Vars

Procs

Var Details

var expected_colors –

var flat_all_layers – /list

var height –

var icon_cache – /list

var icon_file –

var icon_file_hash –

var icon_states – /list

var json_config –

var json_config_hash –

var live_edit_types – /list

var material_skin – /datum/material

var name –

var string_icon_file –

var string_json_config –

var width –