hex-world
    Preparing search index...

    Interface TerrainGridOptions

    Appearance and behavior of the shader hex grid overlay. All fields optional — unset fields keep their current value.

    interface TerrainGridOptions {
        enabled?: boolean;
        color?: ColorRepresentation;
        opacity?: number;
        lineWidth?: number;
        fadeStart?: number;
        fadeEnd?: number;
    }
    Index

    Properties

    enabled? color? opacity? lineWidth? fadeStart? fadeEnd?

    Properties

    enabled?: boolean

    Show or hide the grid. Defaults to true when configureTerrainGrid is called.

    color?: ColorRepresentation

    Line color. Default a near-black blue-grey.

    opacity?: number

    Line opacity 0–1 at full strength (before distance/slope fading). Default 0.45.

    lineWidth?: number

    Line width in world units, centered on the cell border. Default 0.06.

    fadeStart?: number

    Camera distance at which the grid starts fading out. Default 25.

    fadeEnd?: number

    Camera distance at which the grid is fully faded. Default 70.

    Settings

    Member Visibility

    On This Page

    Properties