inkBoil.styleBlock
- .metadata121 B
- README.md2.4 KB
- block.yaml761 B
README.md
Ink boil (styleBlock, Time)
Makes every line and wash edge tremble together, redrawn on each step of the held clock, like hand-drawn animation where each frame is traced again.
Settings: amount (1.6 reference px), size (1.5 cells per metre), calm (0.5). It draws nothing itself: it publishes the stack's shared wobble, and every block that reads the wobble (the depth line, the sketch line, the flat wash) offsets its edges by it, so a wash and its ink line boil together on one clock. The stack's holdRate sets how often it is redrawn (8 steps a second by default).
What it gives up in motion
Edges move a little on every held step even when the world stands still. That is the point of the block, and it never runs faster than the held clock, so it reads as drawn animation rather than as noise. Where one cell of its pattern would cover fewer than about 8 drawn pixels (far ground near the horizon, and more of the picture on the half-resolution low tier) the wobble fades out, full from 8 pixels a cell and none under 3, so it never jumps from pixel to pixel and breaks lines into dashes. The wobble pattern is laid on surfaces, so a pan does not drag it; it is re-seeded each step. The paper does not boil: grounds do not read the wobble.
How it treats content
- Opaque things: their lines and wash edges wobble.
- Transparent things (glass, water): no lines of their own, so nothing boils on them.
- Particles and smoke: untouched.
- Sky: no edges to move, untouched; silhouettes against the sky boil.
- Fog: far edges calm with distance (
calm), so a foggy horizon stays quiet. - Skinned characters: their outlines boil like anything else.
- Foliage: leaf outlines boil, which can get busy; lower
amount. - World text: text outlines boil if a line block draws them; exclude labels that must stay steady.
- Black stays black: it moves edges, it adds no light.
Known limits
- It runs on the whole frame after antialiasing, so offscreen captures, mirrors and render-to-texture cameras do not show it (#17427).
- Per-object settings (a style channel or a game role) reach it through the shared object mask, at most eight distinct settings a scene. A per-object value cannot reach a geometry pass, so a per-object look that needs one draws passes of its own (#24549).
- Its passes are queued again every frame, even when nothing changed (#24548).
The package README's Known limits lists the rest.