yolkbot
    Preparing search index...

    Interface MapJSON

    The full map JSON fetched when you join a game loadMap

    interface MapJSON {
        ambient: string;
        availability: "private" | "both" | "public";
        data: Record<string, MapCell[]>;
        depth: number;
        extents: MapExtents;
        fileVersion: 2;
        fog: MapFog;
        height: number;
        modes: MapModes;
        name: string;
        numPlayers: string;
        palette: string[];
        render: MapRender;
        skybox: "default" | "moonbase" | "night" | "whimsical";
        sun: MapSun;
        surfaceArea: number;
        width: number;
    }
    Index

    Properties

    ambient availability data depth extents fileVersion fog height modes name numPlayers palette render skybox sun surfaceArea width

    Properties

    ambient: string

    Ambient properties

    availability: "private" | "both" | "public"

    Whether the map is available in private only or pubs & privs

    data: Record<string, MapCell[]>

    An object of each map mesh along with all of the places it occurs

    depth: number

    The map depth

    extents: MapExtents

    The map extents

    fileVersion: 2

    The map "file version"

    fog: MapFog

    Fog properties

    height: number

    The map height

    modes: MapModes

    The modes the map may be used in

    name: string

    The stylized map name

    numPlayers: string

    The number of players the map is recommended for

    palette: string[]

    A list of map meshes the map uses

    render: MapRender

    Special render keys for Babylon

    skybox: "default" | "moonbase" | "night" | "whimsical"

    The map's skybox used

    sun: MapSun

    Sun properties

    surfaceArea: number

    The map surface area

    width: number

    The map width

    Settings

    Member Visibility

    On This Page

    Properties