CONTENT CONTRACT · VERSION 1
FxDefinition
A visual effect drawn by an engine primitive: glow, particles and an optional point light.
Signature
{ color_rgb: {ColorChannel}, duration_ticks: PositiveTicks, glow_rgb: {ColorChannel}, id: ContentId, light: (LightId)?, particles: Count, primitive: FxPrimitive, size_mm: PositiveDistance, sound: (AudioCueId)? }Fields
| Name | Type | Meaning |
|---|---|---|
color_rgb | {ColorChannel} | Core color, red, green and blue. Items: 3…3 |
duration_ticks | PositiveTicks | How long it shows; an orb shows while its body flies. Range: 1…2147483647; Unit: tick |
glow_rgb | {ColorChannel} | Glow and particle color, red, green and blue. Items: 3…3 |
id | ContentId | Package-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}$ |
light | LightId | Point light it casts while it shows. Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: light |
particles | Count | Particles it throws. Range: 0…2147483647; Unit: count |
primitive | FxPrimitive | Engine primitive drawing the effect. |
size_mm | PositiveDistance | Size: the radius of an orb, the final radius of a burst, ring or nova. Range: 1…2147483647; Unit: mm |
sound | AudioCueId | Sound it plays where it appears. Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: audio_cue |