> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rollingquest.kramgames.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PoolData — Lava Pool Configuration Reference

> API reference for the PoolData class in RollingQuest Lua scripting. Configure lava pool mode, height, velocity, amplitude, and frequency.

The `PoolData` class represents the configuration for a lava or liquid pool within the level. You access it via `Level.lavaPool`.

## Properties

| Property        | Type       | Read/Write | Description                                              |
| --------------- | ---------- | ---------- | -------------------------------------------------------- |
| `mode`          | `PoolMode` | ❌          | Pool behavior mode (Disabled, Static, AutoAdjust, Tide). |
| `isActive`      | `boolean`  | ✅          | Whether the pool is currently active.                    |
| `targetHeight`  | `number`   | ❌          | Target height of the liquid surface.                     |
| `currentHeight` | `number`   | ❌          | Current height of the liquid surface.                    |

### AutoAdjust Parameters

| Property       | Type     | Read/Write | Description                           |
| -------------- | -------- | ---------- | ------------------------------------- |
| `velocity`     | `number` | ❌          | Speed of automatic height adjustment. |
| `maxVelocity`  | `number` | ❌          | Maximum adjustment speed.             |
| `acceleration` | `number` | ❌          | Acceleration rate for height changes. |

### Tide Parameters

| Property    | Type     | Read/Write | Description                         |
| ----------- | -------- | ---------- | ----------------------------------- |
| `amplitude` | `number` | ❌          | Height variation of the tide cycle. |
| `frequency` | `number` | ❌          | Speed of the tide oscillation.      |

## Usage Example

```lua theme={null}
function OnStart()
    local pool = Level.lavaPool
    pool.mode = PoolMode.Tide
    pool.amplitude = 2.0
    pool.frequency = 0.5
    pool.targetHeight = 5.0
end
```