Log inGet started
World

Tidewater: Oceans, Lakes, Rivers, Waterfalls, Swimming and Splashes Water Kit

Branchmain
Commit431c1b9967

README.md

fx

Tidewater's water effects are their own package, tidewaterFx (/tidewaterFx.package), so any game or kit can use them without Tidewater. This module re-exports it unchanged:

local Fx = require("tidewater.modules.fx")    -- same table as require("tidewaterFx.modules.fx")
Fx.splash("plop", { x, y, z })
Fx.ripple({ x, y, z }, 0.5)

Requiring it through Tidewater also registers two hooks: the look of a Tidewater water at a point (Fx.setLookProvider("tidewater", Water.lookAt)), so a splash on a cartoon lake is cartoon, and the ocean foam stamp wakes leave in the sea (Fx.setFoamStamper). See the tidewaterFx README.