EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Definitions

light

A light profile an equipped item may emit.

Feature
actors
Rights
none
Errors
invalid_type faultmissing_reference faultout_of_range faultunknown_field fault

Signature

{ attachment: Name, color_rgb: {ColorChannel}, id: ContentId, intensity_permille: Permille, kind: "light", radius_mm: PositiveDistance }

Fields

NameTypeMeaning
attachmentNameRig attachment point carrying the light.
Length: 1…96; Pattern: ^[a-z][a-z0-9_]{0,95}$
color_rgb{ColorChannel}Red, green and blue channels in that order.
Items: 3…3
idContentIdPackage-qualified identity; unique within its declaring namespace.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$
intensity_permillePermilleBrightness in thousandths of the standard light.
Range: 0…1000; Unit: permille
kind"light"Discriminant
radius_mmPositiveDistanceReach of the light.
Range: 1…2147483647; Unit: mm

Validated example

{
  "attachment": "spell",
  "color_rgb": [
    170,
    120,
    255
  ],
  "id": "core:arcane_glow",
  "intensity_permille": 800,
  "kind": "light",
  "radius_mm": 9000
}