AutoMovie API
    Preparing search index...

    Interface IAutoMovieFluidDrain

    One declared outflow from a single cell.

    validateFluidDomain requires a nonsolid in-grid cell, a nonblank id unique among drains and finite authored numbers. The solver limits requested drain/face outflows against held water and records drainVolume; nonfinite intermediate and ledger handling retains IAutoMovieFluidState's documented gaps.

    interface IAutoMovieFluidDrain {
        column: number;
        end: number | null;
        flowRate: number;
        id: string;
        row: number;
        sillLevel: number;
        start: number;
    }
    Index
    column: number

    Cell column the water leaves from; 0 <= column < grid.columns.

    end: number | null

    Closing second strictly after start, or null for no close.

    flowRate: number

    Finite nonnegative requested maximum outflow in cubic metres per second. When requested drain and outgoing-face volumes exceed held water, the solver scales them by one factor; the documented intermediate-arithmetic limits still apply.

    id: string

    Stable drain identity within the domain.

    row: number

    Cell row the water leaves from; 0 <= row < grid.rows.

    sillLevel: number

    Free-surface threshold in metres above grid.origin.y, such as an overflow sill or floor-drain bed elevation. A step drains only when its initial bed + depth is strictly above the threshold.

    start: number

    Nonnegative domain-clock opening second; a step drains when its start time satisfies start <= t < end.