Ocean
The module itself: require(game.ReplicatedStorage.Ocean). Everything you need day to day is here:
weather, zones, water queries, water events and tag helpers. The other classes are the pieces it is
built from; reach for them only when you need something lower level.
local Ocean = require(game.ReplicatedStorage.Ocean)
-- server: define a weather and cross-fade the whole sea into it over 20 seconds
Ocean:CreateWeather("Rough", Ocean.Presets.Ocean["Pirate Seas"])
Ocean:SetWeather("Rough", 20)
-- anywhere: where is the surface right now?
local y = Ocean:GetHeight(boat.Position)
Settings are attributes on the module (see Settings); the server owns them and they replicate. The bootstrap scripts the plugin installs call Ocean.Init once on the server and once on every client, so you never have to.
Properties
Settings
Ocean.Settings: SettingsThe settings spec and accessors.
Waves
Ocean.Waves: WavesThe wave function: heights, displacement, obstacles.