Daedalus Dock - Modules - TypesVar Details - Proc Details

greyscale_config

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

Vars

expected_colorsHow many colors are expected to be given when building the sprite
flat_all_layersA list of all layers irrespective of nesting
heightSpritesheet height of the icon_file
icon_cacheGenerated icons keyed by their color arguments
icon_fileReference to the dmi file for this config
icon_file_hashThe md5 file hash for the icon file. Used to check if the file has changed
icon_statesA list of icon states and their layers
json_configReference to the json config file
json_config_hashThe md5 file hash for the json configuration. Used to check if the file has changed
live_edit_typesA list of types to update in the world whenever a config changes
material_skinAn optional var to set that tells the material system what material this configuration is for. Use a typepath here, not an instance.
nameUser friendly name used in the debug menu
string_icon_fileString path to the icon file, used for reloading
string_json_configString path to the json file, used for reloading
widthSpritesheet width of the icon_file

Procs

CrossVerifyCalled after every config has refreshed, this proc handles data verification that depends on multiple entwined configurations.
DebugNameGets the name used for debug purposes
GenerateActually create the icon and color it in, handles caching
GenerateBundleHandles the actual icon manipulation to create the spritesheet
GenerateLayerGroupInternal recursive proc to handle nested layer groups
ReadIconStateConfigurationTakes the json icon state configuration and puts it into a more processed format.
ReadLayersFromJsonTakes the json layers configuration and puts it into a more processed format
ReadMetadataReads layer configurations to take out some useful overall information
RefreshCall this proc to handle all the data extraction from the json configuration. Can be forced to load values from disk instead of memory.
SaveOutputFor saving a dmi to disk, useful for debug mainly

Var Details

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

Proc Details

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