Module:Swatches/data/doc

From Dune: Awakening Community Wiki
Jump to navigation Jump to search

This is the documentation page for Module:Swatches/data

Module:Swatches/data

Dataset of cosmetic swatches.

Schema

The dataset is a dictionary keyed by swatch name. Each key represents the display name of a swatch. The key is case-preserving and used directly for display and sorting.

Record fields

Each value is a table with the following fields:

colors
string[4]
Array of 4 hex color strings: [1] top, [2] left, [3] right, [4] bottom.
This reflects the ordering under DuneSandbox/Content/Dune/Systems/Customization/DyePacks, where the swatch values can also be found.
However, for ease of viewing, the rendered swatch infobox displays them clockwise starting from the top (i.e. 1/3/4/2).
Examples:
#000000
#ffffff
link (optional)
string
Wiki page name to link the swatch title to.
scopes (optional)
string[]
Compatibility scopes for the swatch. All values must be lowercase.
If omitted, the swatch applies to all scopes.
Valid values:
vehicle
weapon
garment
placeable
onlyClasses (optional)
string[]
Specific classes that the swatch applies to, in the form of <scope>:<class>.
scope must be lowercase and must match one of the valid scope values.
class is case-preserving and used directly for display.
If present, the swatch applies only to the specified classes.
If omitted, the swatch applies to all classes within its specified scopes.
Examples:
vehicle:Scout Ornithopter
weapon:Rapiers
garment:Stillsuits