AutoMovie API
    Preparing search index...

    Construct a rectangular planar ramp from a centerline, width and rise.

    type IInput = {
        baseHeight: number;
        from: { x: number; z: number };
        id: string;
        rise: number;
        to: { x: number; z: number };
        walkable: boolean;
        width: number;
    }
    Index
    baseHeight: number

    Finite world Y in metres at from; may be negative.

    from: { x: number; z: number }

    World XZ centerline start, where the plane has baseHeight. Endpoints must produce finite positive squared separation.

    Type Declaration

    • x: number

      Centerline start world X in metres.

    • z: number

      Centerline start world Z in metres.

    id: string

    Nonblank surface identity; the constructor rejects whitespace-only text and preserves spelling.

    rise: number

    Finite signed height change in metres from from to to. Zero makes a flat ramp, and negative values descend along the directed centerline.

    to: { x: number; z: number }

    World XZ centerline end, where the plane has baseHeight + rise. Distinctness is checked through squared separation, including its underflow/overflow limits.

    Type Declaration

    • x: number

      Centerline end world X in metres.

    • z: number

      Centerline end world Z in metres.

    walkable: boolean

    Authored support permission copied unchanged; neither steepness nor direction changes it automatically.

    width: number

    Finite positive full width in metres perpendicular to the centerline; the footprint extends half this distance on each side.