Log inGet started
World

Style Cookbook: Mix Your Own Art Style from Stackable Look Blocks

README.md

LookbookAnimator

Moves one thing in the Lookbook scene from lookbook time T (LookbookClock.time()). Every pose it writes is a pure function of T and its fields, with nothing accumulated frame to frame, so the same T always draws the same frame. It ticks in update and in editorUpdate (guarded on engine.paused, so it runs once a frame in every mode), and registers with LookbookClock so a run can count the animators and wait for them (LookbookClock.apply() waits two frames). It only ever writes its own entity, from its own tick: a write made from a caller's code would be recorded as an authoring edit to the scene.

Put it on the entity it moves. Light modes need a Light (or SpotLight) on the same entity; fog needs a HeightFog; character needs a skinned humanoid somewhere beneath the entity (an Asset of @builtin::avatars.humanoid on a child works).

Modes

ModeWhat it doesFields it reads
spinTurns about axis at speed degrees per second.axis, speed, rotation, phase
stepSpinThe same turn, held between steps taken rate times a second (6, 12, 24, 60 in the mixed-rates stop).axis, speed, rate, rotation, phase
slideBack and forth between from and to, one round trip per period.from, to, period, phase
swayRocks about axis by amplitude degrees at speed cycles per second, two sines like gusting wind.axis, amplitude, speed, rotation, phase
characterRuns the entity between from and to (round trip per period), facing its way of travel, and samples clip at T on the skinned body beneath it.from, to, period, clip, clipSpeed, yawOffset, phase
lightRampEases the light's intensity from valueFrom to valueTo across the window.valueFrom, valueTo, segment or window0/window1
sunRotateSwings a directional light's direction from about world axis by up to amplitude degrees and back inside the window; intensity valueFrom.from, axis, amplitude, window, valueFrom
spotMoveCarries the light round a circle (center, radius, speed cycles per second) aimed at to.center, radius, speed, to, valueFrom
lightsOffHolds the light at valueFrom and at 0 inside the zeroLights segment.valueFrom
fogSets a HeightFog's density to valueTo inside the window and valueFrom outside it.valueFrom, valueTo, window

Every light mode puts its light at 0 inside the path's zeroLights segment while offInZeroLights is on, which is how the Lookbook makes its black frame.

The window is segment (a name from LookbookPath.segments()) when set, otherwise window0..window1 in lookbook seconds.

Notes

  • character drives its own one-clip AnimGraph and sets the clip's playhead to T * clipSpeed (wrapped to the clip length) each frame, then applies the pose, so the body's pose follows T exactly. The skeleton must have hydrated; until it has, the body moves but holds its bind pose.
  • Writes are absolute, so a scene saved mid-animation loads back to the same motion.

Known limits

  • Two engines on one account join as one player, so a two-player check needs two accounts or two machines (#14448).
  • A world boot can wait about 30 s on a network handshake before any content starts (#24669).
  • A two-client editor sometimes refuses to load two different scenes at once (#24666, #24667).

The package README's Known limits lists the rest.