Module:Swatches/data/doc
< Module:Swatches | data
This is the documentation page for Module:Swatches/data
Module:Swatches/data
Dataset of cosmetic swatches.
Schema
Each swatch entry is a table with the following fields:
- name
- string
- Display name of the swatch (Title Case).
- image
- string
- File name of the swatch preview image.
- colors
- string[4]
- Array of 4 hex color strings, with the main color ordered first, then continuing clockwise.
- Examples:
- •
"#000000" - •
"#ffffff"
- •
- scopes
- string[]
- Compatibility scopes for the swatch.
- One of:
- •
"All"(this overrides all other values) - •
"Vehicle" - •
"Weapon" - •
"Garment" - •
"Placeable"
- •
- onlyItems (optional)
- string[]
- Specific items the swatch applies to, in the form of
<Scope>:<Item>. Itemmust match the value used for theitem=parameter when filtering with Module:Swatches.- If present, the swatch applies only to the specified items.
- If omitted, the swatch applies to all items within its specified
scopes. - Examples:
- •
"Vehicle:Sandbike" - •
"Weapon:Rapiers"
- •
- link (optional)
- string
- Wiki page name to link the swatch title and image to.
- If omitted, the swatch is displayed without a link.