Small World Engine API Reference - v0.76.20
    Preparing search index...

    Interface GridLegendEntry

    interface GridLegendEntry {
        ceilingMaterial?: AbstractMaterial;
        ceilingTexture?: Texture;
        isDynamic?: boolean;
        material?: AbstractMaterial;
        offsetY?: number;
        onBuild?: (
            x: number,
            y: number,
            worldX: number,
            worldZ: number,
            scene: Scene,
        ) => void | Object3D;
        preventFloorCeiling?: boolean;
        scale?: number | Vector3D;
        tag?: string;
        texture?: Texture;
        type: GridTileType;
    }
    Index
    ceilingMaterial? ceilingTexture? isDynamic? material? offsetY? onBuild? preventFloorCeiling? scale? tag? texture? type
    ceilingMaterial?: AbstractMaterial
    ceilingTexture?: Texture

    Ceiling texture/material (for floor type)

    isDynamic?: boolean

    If true, the object will not be added to the static octree (e.g. for dynamic elements)

    material?: AbstractMaterial
    offsetY?: number

    Custom Y offset for sprites/blocks

    onBuild?: (
        x: number,
        y: number,
        worldX: number,
        worldZ: number,
        scene: Scene,
    ) => void | Object3D

    Custom builder callback for total control

    preventFloorCeiling?: boolean

    If true, the floor and ceiling won't be generated for this tile

    scale?: number | Vector3D

    Scale for block/sprite types

    tag?: string

    Optional generic identification tag applied to the built floor object (e.g. for gameplay hazard checks)

    texture?: Texture

    Primary texture or material

    type: GridTileType

    The type of tile to generate

    Settings
    Member Visibility

    On This Page
    Properties