Log inGet started
Package

Woodblock.module

README.md

Woodblock (module)

The ukiyoeBlocks API: local Woodblock = require("~ukiyoeBlocks.Woodblock").

  • Woodblock.apply(lookId, { keep?, roles? }): a whole woodblock look in one change, with its palette and the woodblock role set; water level and weather carry over.
  • Woodblock.looks(), Woodblock.blocks(slot?), Woodblock.describe().
  • One piece at a time: useLine(id), usePaper(id), usePalette(id), useSky("dawn" | "day" | "dusk" | "night" | "shore"), shadows("ukiyoe" | "shinHanga" | "shinHangaNight"), pattern("waves" | "clouds" | "mist" | "snow", on), registration(on, x?, y?), margin(on, settings?).
  • World state: timeOfDay(t), weather("rain" | "snow" | "clear", intensity?), setWater(y). Weather is real Cloudburst weather in its ink looks (see WoodblockWeather); weatherOf() reads what is falling.
  • Roles: give(entity, "hero" | "enemy" | "friendly" | ...).
  • clear() takes the look off.

Every call is a change to the scene's synced styleKit stack: every player sees it, a late joiner gets it with the scene, and it is saved with the scene.