inkBlocks.package
- ..
- .metadata165 B
- README.md4.7 KB
- block.yaml2.4 KB
This package holds more than this page lists. See all of its files in its world.
README.md
Splatter and drips (styleBlock, Fill)
Flicked ink splats with spiky rims and thrown droplets sitting on surfaces, drips running down walls to a bead, and a fine spray where things meet: the energy of spattered comic ink, gritty illustration and expressive ink drawing.
Settings: ink (#0a090a), setInk (1), amount (0.18), cellSize (0.9), size (0.5), spikes (0.5), droplets (0.6), drip (0.5), spray (0.6), sprayReach (40), opacity (0.95), accentShare (0), seed (0), fadeEnd (60), nearFade (2). Low quality draws no fine spray (spray 0) and fewer droplets (droplets 0.3); like every block it runs at half resolution there.
It reads depth, the copied normals (or the normal rebuilt from world positions on the forward path), the frame and the pigment set. Every mark is laid on the surface in metres: the surface is divided into cells cellSize metres across, amount of them hold a splat of size against the cell with a rim bent by spikes, ringed by up to six thrown droplets (droplets); on walls (surfaces facing sideways) drip of the splats run straight down in a drip that ends in a bead. A fine spray of specks gathers where things meet, found from concave folds in depth at sprayReach reference pixels around the pixel (spray). Marks smaller than a couple of pixels are left out, so far surfaces never fill with speckle, and everything fades out over the last third of the way to fadeEnd. Splats land on lit and shadowed surfaces alike: it does not read the picture's tone. The ink is ink, or the picked ink set's first paint by setInk (white splats with inkWhiteOnDark); accentShare of the splats are drawn in the accent ink. With accentShare above 0 the accent is the set's second paint when it has one (inkRedAccent's vermilion), and a built-in vermilion otherwise, including with no set picked. seed picks which cells hold a splat (the same seed gives the same splats on every machine). It sits last in the ink Fill chain (rank 80, stacking chain). It has no wobble setting and does not read the shared wobble, so splats never tremble with the boil.
What it gives up in motion
Every splat, drip and droplet is laid on the surface in metres, so it stays put on still things under pan, dolly, orbit and zoom and never changes on its own: nothing in it follows the clock. Because it comes from world position, it slides across moving characters and props like a pattern projected onto them: keep it off them with a group mask. Splats keep their size on the surface, so they grow as you walk closer, like real ink on a wall. The spray's reach is measured in pixels on screen while its specks sit on the surface, so as you dolly in the band where spray gathers narrows on the surface while each speck stays where it is.
How it treats content
- Opaque things: splats, droplets and drips sit on every surface, walls take the drips, and spray gathers in corners and at the foot of walls.
- Transparent things (glass, water): no depth, so splats are laid on the surface behind the glass or under the water and drawn over the glass; a pond shows splats on its bed.
- Particles and smoke: splats belong to the surface behind smoke and are drawn over it.
- Sky: never splattered.
- Fog: splats are drawn at full ink over fogged surfaces until they fade by
fadeEnd(60 m); in thick, near fog lowerfadeEndso dark splats do not float in pale fog. - Skinned characters: splats slide across a moving body. Keep them off characters with a group mask (
StyleKit.options({ groups = { { bodyId } } }),StyleKit.setMask("splat", { kind = "group", group = 1, invert = true })). - Foliage: leaves are surfaces and take splats; on swaying foliage the splats stay in the world while the leaves move through them, which reads as flicker on wind-blown trees. Mask trees if that shows.
- World text: splats land on signs and can cover letters. Exclude labels a player must read by name:
StyleKit.options({ exclude = { "labelName" } }). - Black stays black: it returns through
sk_finish, so an unlit pixel stays black; white splats on parts of the scene with no light at all are held black too.
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.