Skip to main content

Presets

Ready-made setting tables, plain data. Each carries only its own keys and applies on top of whatever is already set.

  • [Presets.Physics]: waves and buoyancy. Calm (the defaults), Rough, Huge, Tsunami, Still.
  • [Presets.Visual]: the look. Classic (the defaults, like Roblox water), Cartoony, Stylized, Realistic.
  • [Presets.Ocean]: a whole sea, one physics plus one look. Island, Pirate Seas, Oil Rig, Great Flood, Blank.

Any of them can be a weather: Ocean:CreateWeather("Storm", Ocean.Presets.Ocean["Pirate Seas"]). Weather ignores the non-weather keys (materials, textures, physics).

Properties​

Physics​

</>
Presets.Physics: {[string]: {[string]: any}}

Wave and buoyancy presets by name.

Visual​

</>
Presets.Visual: {[string]: {[string]: any}}

Look presets by name.

Ocean​

</>
Presets.Ocean: {[string]: {[string]: any}}

Whole-sea presets by name.

Lighting​

</>
Presets.Lighting: {[string]: any}

Per Ocean preset, the Lighting properties and Atmosphere/effects the plugin applies with it.

Aliases​

</>
Presets.Aliases: {[string]: string}

Older preset names mapped to current ones (Storm, Deep Sea, Flat, Calm).

Functions​

Find​

</>
Presets.Find(name: string) → {[string]: any}?

An Ocean preset by name, aliases included.

Show raw api
{
    "functions": [
        {
            "name": "Find",
            "desc": "An Ocean preset by name, aliases included.",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ [string]: any }?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "packages/src/Ocean/Presets.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Physics",
            "desc": "Wave and buoyancy presets by name.",
            "lua_type": "{ [string]: { [string]: any } }",
            "source": {
                "line": 26,
                "path": "packages/src/Ocean/Presets.luau"
            }
        },
        {
            "name": "Visual",
            "desc": "Look presets by name.",
            "lua_type": "{ [string]: { [string]: any } }",
            "source": {
                "line": 31,
                "path": "packages/src/Ocean/Presets.luau"
            }
        },
        {
            "name": "Ocean",
            "desc": "Whole-sea presets by name.",
            "lua_type": "{ [string]: { [string]: any } }",
            "source": {
                "line": 36,
                "path": "packages/src/Ocean/Presets.luau"
            }
        },
        {
            "name": "Lighting",
            "desc": "Per Ocean preset, the Lighting properties and Atmosphere/effects the plugin applies with it.",
            "lua_type": "{ [string]: any }",
            "source": {
                "line": 41,
                "path": "packages/src/Ocean/Presets.luau"
            }
        },
        {
            "name": "Aliases",
            "desc": "Older preset names mapped to current ones (`Storm`, `Deep Sea`, `Flat`, `Calm`).",
            "lua_type": "{ [string]: string }",
            "source": {
                "line": 46,
                "path": "packages/src/Ocean/Presets.luau"
            }
        }
    ],
    "types": [],
    "name": "Presets",
    "desc": "Ready-made setting tables, plain data. Each carries only its own keys and applies on top of whatever\nis already set.\n\n- [Presets.Physics]: waves and buoyancy. `Calm` (the defaults), `Rough`, `Huge`, `Tsunami`, `Still`.\n- [Presets.Visual]: the look. `Classic` (the defaults, like Roblox water), `Cartoony`, `Stylized`, `Realistic`.\n- [Presets.Ocean]: a whole sea, one physics plus one look. `Island`, `Pirate Seas`, `Oil Rig`, `Great Flood`, `Blank`.\n\nAny of them can be a weather: `Ocean:CreateWeather(\"Storm\", Ocean.Presets.Ocean[\"Pirate Seas\"])`.\nWeather ignores the non-weather keys (materials, textures, physics).",
    "source": {
        "line": 21,
        "path": "packages/src/Ocean/Presets.luau"
    }
}