turretsKit.package
- ..
- .metadata304 B
- README.md3.0 KB
- schema.yaml2.1 KB
README.md
turretsKit.turretStyle
The data contract a turret look style is checked against. A style paints every turret
(material and colour per part slot, a few shape switches) and picks the projectile look
(from projectileKit.looks) each kind of shot uses. The kit ships three in
turretsKit.package/styles/: scifi, medieval and toy.
A Turret component picks a style with its style field ("auto" follows the world
default set by turretsKit.api.setStyle). Add a style by adding a .data file with
contract: turretsKit.turretStyle, or from code with turretsKit.api.defineStyle(id, def, base).
Fields
| Field | Type | Default | Meaning |
|---|---|---|---|
id | string | required | Name used by style fields and setStyle. |
label | string | required | Display name. |
description | string | "" | One-paragraph description. |
tags | list of strings | [] | Tags for filtering and picking: listed with the look by TK.styles(), and TK.styles(tag) filters by one. |
bodyMaterial | plastic metal glow stone wood | metal | Material of body parts. |
trimMaterial | same | metal | Material of trim parts. |
baseMaterial | same | metal | Material of the base. |
body | color | #c8ccd4 | Body colour. |
trim | color | #33363d | Trim colour. |
base | color | #55595f | Base colour. |
glow | color | #33ddff | Glowing accent colour. |
bodyFromTurret | number 0..1 | 0 | How far body colour is blended toward the turret type's own color. |
glowFromTurret | number 0..1 | 1 | How far glow colour is blended toward the turret type's color. |
rounded | boolean | false | Box parts use the rounded-box mesh. |
base_shape | plate tower block | plate | Base the turret stands on. |
crenellations | boolean | false | Battlements on a tower base. |
banner | boolean | false | A banner on the base (and on walls). |
scale | number ≥ 0.2 | 1 | Multiplies every turret's model size (on top of the tier's scale). |
stone and wood currently render as tinted plastic.
shots (struct): projectile look per shot slot
| Slot | Default | Used for |
|---|---|---|
bullet | tracer | Machine gun bullets |
shell | shell | Cannon shells |
mortar | shell | Mortar shells |
missile | missile | Missiles |
missileTrail | smoke | Puffs dropped behind missiles |
beam | laserRed | Laser beam |
arc | arcCyan | Tesla lightning |
frost | frost | Frost shots |
poison | poison | Poison shells in flight |
cloud | poison | Poison cloud puffs |
sniper | snipeTrail | Sniper trail |
flame | flame | Flame spray puffs |
blast | blast | Explosions where shells and missiles land |
muzzle | muzzle | Muzzle flash |
ring | shockRing | Declared ring slot (aura and poison rings currently use fixed looks) |
Each value is a look name from projectileKit.looks; projectileKit.api.defineLook
adds new ones.