actor.rpg.generator

rpg.actor

Documentation

Stores the recolored layers and configuration used to rebuild a generated sprite.

main record
1 example

Stores the recolored layers and configuration used to rebuild a generated sprite.

Record Key literal:self Fixed literal value

Properties

bodyType string Required

No description available.

maxLength: 20 bytes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

eyes ref #eyes Required

No description available.

faceMode string Optional

Whether face layers are selected intentionally. Omission is reserved for legacy records pending migration.

Known values: standard, faceless
items array of string Optional

No description available.

maxLength: 20 items
layers array of ref #layer Required

Ordered recolored layers, back-to-front.

maxLength: 32 items
skin ref #skin Required

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema
{
  "description": "Stores the recolored layers and configuration used to rebuild a generated sprite.",
  "key": "literal:self",
  "record": {
    "properties": {
      "bodyType": {
        "maxLength": 20,
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "eyes": {
        "ref": "#eyes",
        "type": "ref"
      },
      "faceMode": {
        "description": "Whether face layers are selected intentionally. Omission is reserved for legacy records pending migration.",
        "knownValues": [
          "standard",
          "faceless"
        ],
        "type": "string"
      },
      "items": {
        "items": {
          "maxLength": 50,
          "type": "string"
        },
        "maxLength": 20,
        "type": "array"
      },
      "layers": {
        "description": "Ordered recolored layers, back-to-front.",
        "items": {
          "ref": "#layer",
          "type": "ref"
        },
        "maxLength": 32,
        "type": "array"
      },
      "skin": {
        "ref": "#skin",
        "type": "ref"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "bodyType",
      "skin",
      "eyes",
      "layers",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
colors object

Selected recolor channels.

Properties

main string Optional

No description available.

maxLength: 7 bytes
sub1 string Optional

No description available.

maxLength: 7 bytes
sub2 string Optional

No description available.

maxLength: 7 bytes
sub3 string Optional

No description available.

maxLength: 7 bytes
View raw schema
{
  "description": "Selected recolor channels.",
  "properties": {
    "main": {
      "maxLength": 7,
      "type": "string"
    },
    "sub1": {
      "maxLength": 7,
      "type": "string"
    },
    "sub2": {
      "maxLength": 7,
      "type": "string"
    },
    "sub3": {
      "maxLength": 7,
      "type": "string"
    }
  },
  "type": "object"
}
eyes object

Eye color configuration.

Properties

hex string Optional

No description available.

maxLength: 7 bytes
mode string Optional

No description available.

maxLength: 10 bytes
tone integer Optional

No description available.

minimum: 0maximum: 100
View raw schema
{
  "description": "Eye color configuration.",
  "properties": {
    "hex": {
      "maxLength": 7,
      "type": "string"
    },
    "mode": {
      "maxLength": 10,
      "type": "string"
    },
    "tone": {
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}
fallback object

Rendered replacement used when a layer is class-suppressed.

Properties

assetName string Required

No description available.

maxLength: 100 bytes
behindRows array of integer Optional

No description available.

maxLength: 4 items
blob blob Required

No description available.

maxSize: 1.0 MB
colors ref #colors Optional

No description available.

subtractMask blob Optional

No description available.

maxSize: 50.0 KB
title string Optional

No description available.

maxLength: 100 bytes
zSlot integer Optional

No description available.

minimum: 0maximum: 30
zSlotByDir unknown Optional

No description available.

View raw schema
{
  "description": "Rendered replacement used when a layer is class-suppressed.",
  "properties": {
    "assetName": {
      "maxLength": 100,
      "type": "string"
    },
    "behindRows": {
      "items": {
        "maximum": 3,
        "minimum": 0,
        "type": "integer"
      },
      "maxLength": 4,
      "type": "array"
    },
    "blob": {
      "accept": [
        "image/png"
      ],
      "maxSize": 1000000,
      "type": "blob"
    },
    "colors": {
      "ref": "#colors",
      "type": "ref"
    },
    "subtractMask": {
      "accept": [
        "image/png"
      ],
      "maxSize": 50000,
      "type": "blob"
    },
    "title": {
      "maxLength": 100,
      "type": "string"
    },
    "zSlot": {
      "maximum": 30,
      "minimum": 0,
      "type": "integer"
    },
    "zSlotByDir": {
      "type": "unknown"
    }
  },
  "required": [
    "assetName",
    "blob"
  ],
  "type": "object"
}
layer object

A rendered generator layer and its recomposition metadata.

Properties

assetName string Optional

No description available.

maxLength: 100 bytes
behindRows array of integer Optional

Rows rendered behind the body. Empty explicitly means all rows render in front.

maxLength: 4 items
blob blob Required

No description available.

maxSize: 1.0 MB
colors ref #colors Optional

No description available.

disabled boolean Optional

No description available.

id string Required

No description available.

maxLength: 30 bytes
layerClass string Optional

Class assigned to this layer, such as hind.cloak.

maxLength: 90 bytes
submaskExclusions ref #submaskExclusions Optional

Target-side exceptions to submaskRule. The layers array contains exact canonical source layer IDs and the classes array contains exact source layerClass or fitClass values; matching source masks are skipped before submaskRule is evaluated. Omission or empty arrays means no source-specific exclusions.

submaskRule string Optional

Controls which external subtractive masks may affect this layer. Omission means respect-all.

maxLength: 24 bytes
Known values: respect-all, ignore-all, ignore-layers-above, ignore-layers-below
subtractMask blob Optional

No description available.

maxSize: 50.0 KB
suppressAs ref #fallback Optional

No description available.

suppressSpecific unknown Optional

Map from suppressor layerClass to either a structured fallback matching #fallback or a rule with default and bodyTypeAlt fallbacks. The active body-specific value takes priority over the class default, then suppressAs.

title string Optional

No description available.

maxLength: 100 bytes
zSlot integer Optional

Legacy all-direction draw-order slot. zSlotByDir takes precedence.

minimum: 0maximum: 30
zSlotByDir unknown Optional

Per-direction draw-order slots [down, left, right, up]. Entries are non-negative integers or null when the category default applies.

View raw schema
{
  "description": "A rendered generator layer and its recomposition metadata.",
  "properties": {
    "assetName": {
      "maxLength": 100,
      "type": "string"
    },
    "behindRows": {
      "description": "Rows rendered behind the body. Empty explicitly means all rows render in front.",
      "items": {
        "maximum": 3,
        "minimum": 0,
        "type": "integer"
      },
      "maxLength": 4,
      "type": "array"
    },
    "blob": {
      "accept": [
        "image/png"
      ],
      "maxSize": 1000000,
      "type": "blob"
    },
    "colors": {
      "ref": "#colors",
      "type": "ref"
    },
    "disabled": {
      "type": "boolean"
    },
    "id": {
      "maxLength": 30,
      "type": "string"
    },
    "layerClass": {
      "description": "Class assigned to this layer, such as hind.cloak.",
      "maxLength": 90,
      "type": "string"
    },
    "submaskExclusions": {
      "description": "Target-side exceptions to submaskRule. The layers array contains exact canonical source layer IDs and the classes array contains exact source layerClass or fitClass values; matching source masks are skipped before submaskRule is evaluated. Omission or empty arrays means no source-specific exclusions.",
      "ref": "#submaskExclusions",
      "type": "ref"
    },
    "submaskRule": {
      "description": "Controls which external subtractive masks may affect this layer. Omission means respect-all.",
      "knownValues": [
        "respect-all",
        "ignore-all",
        "ignore-layers-above",
        "ignore-layers-below"
      ],
      "maxLength": 24,
      "type": "string"
    },
    "subtractMask": {
      "accept": [
        "image/png"
      ],
      "maxSize": 50000,
      "type": "blob"
    },
    "suppress": {
      "ref": "#suppressionRules",
      "type": "ref"
    },
    "suppressAs": {
      "ref": "#fallback",
      "type": "ref"
    },
    "suppressSpecific": {
      "description": "Map from suppressor layerClass to either a structured fallback matching #fallback or a rule with default and bodyTypeAlt fallbacks. The active body-specific value takes priority over the class default, then suppressAs.",
      "type": "unknown"
    },
    "title": {
      "maxLength": 100,
      "type": "string"
    },
    "zSlot": {
      "description": "Legacy all-direction draw-order slot. zSlotByDir takes precedence.",
      "maximum": 30,
      "minimum": 0,
      "type": "integer"
    },
    "zSlotByDir": {
      "description": "Per-direction draw-order slots [down, left, right, up]. Entries are non-negative integers or null when the category default applies.",
      "type": "unknown"
    }
  },
  "required": [
    "id",
    "blob"
  ],
  "type": "object"
}
skin object

Skin color configuration.

Properties

hex string Optional

No description available.

maxLength: 7 bytes
mode string Optional

No description available.

maxLength: 10 bytes
tone integer Optional

No description available.

minimum: 0maximum: 100
View raw schema
{
  "description": "Skin color configuration.",
  "properties": {
    "hex": {
      "maxLength": 7,
      "type": "string"
    },
    "mode": {
      "maxLength": 10,
      "type": "string"
    },
    "tone": {
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}
submaskExclusions object

Target-side exceptions for subtractive masks. List exact canonical source layer IDs in layers, or exact source layerClass or fitClass values in classes; matching source masks must not erase the target layer. Omission or empty arrays means no source-specific exclusions.

Properties

classes array of string Optional

Exact source layerClass or fitClass values whose subtractive masks must be skipped.

maxLength: 64 items
layers array of string Optional

Exact canonical source layer IDs whose subtractive masks must be skipped.

maxLength: 32 items
View raw schema
{
  "description": "Target-side exceptions for subtractive masks. List exact canonical source layer IDs in layers, or exact source layerClass or fitClass values in classes; matching source masks must not erase the target layer. Omission or empty arrays means no source-specific exclusions.",
  "properties": {
    "classes": {
      "description": "Exact source layerClass or fitClass values whose subtractive masks must be skipped.",
      "items": {
        "maxLength": 90,
        "type": "string"
      },
      "maxLength": 64,
      "type": "array"
    },
    "layers": {
      "description": "Exact canonical source layer IDs whose subtractive masks must be skipped.",
      "items": {
        "maxLength": 30,
        "type": "string"
      },
      "maxLength": 32,
      "type": "array"
    }
  },
  "type": "object"
}
suppressionRules object

Layer IDs and classes hidden while this layer is active.

Properties

classes array of string Optional

No description available.

maxLength: 20 items
layers array of string Optional

No description available.

maxLength: 20 items
View raw schema
{
  "description": "Layer IDs and classes hidden while this layer is active.",
  "properties": {
    "classes": {
      "items": {
        "maxLength": 90,
        "type": "string"
      },
      "maxLength": 20,
      "type": "array"
    },
    "layers": {
      "items": {
        "maxLength": 30,
        "type": "string"
      },
      "maxLength": 20,
      "type": "array"
    }
  },
  "type": "object"
}

Lexicon Garden

@