/tg/ Station 13 - 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
heightSpritesheet height of the icon_file
icon_cacheGenerated icons keyed by their color arguments
icon_fileReference to the dmi file for this config
icon_statesA list of icon states and their layers
json_configReference to the json config file
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

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

Var Details

expected_colors

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

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_states

A list of icon states and their layers

json_config

Reference to the json config file

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

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