Strata - v1.4.10
    Preparing search index...

    Interface MinimapConfig

    Configuration for an in-game minimap or radar system.

    interface MinimapConfig {
        backgroundColor?: string;
        borderColor?: string;
        borderRadius?: number;
        borderWidth?: number;
        fogOfWar?: boolean;
        followPlayer?: boolean;
        markerTypes?: Record<string, MinimapMarker>;
        playerColor?: string;
        playerIcon?: string;
        playerSize?: number;
        rotateWithPlayer?: boolean;
        rotation?: number;
        showCompass?: boolean;
        size?: number;
        zoom?: number;
    }
    Index

    Properties

    backgroundColor? borderColor? borderRadius? borderWidth? fogOfWar? followPlayer? markerTypes? playerColor? playerIcon? playerSize? rotateWithPlayer? rotation? showCompass? size? zoom?

    Properties

    backgroundColor?: string

    CSS-compatible background color string.

    borderColor?: string

    CSS-compatible border color string.

    borderRadius?: number

    Corner radius (size/2 for circular maps).

    borderWidth?: number

    Border thickness in pixels.

    fogOfWar?: boolean

    Whether to enable fog-of-war exploration.

    followPlayer?: boolean

    Whether the map centers on the player.

    markerTypes?: Record<string, MinimapMarker>

    Definitions for custom marker types.

    playerColor?: string

    Color for the player indicator.

    playerIcon?: string

    Path to the player icon image.

    playerSize?: number

    Size of the player indicator in pixels.

    rotateWithPlayer?: boolean

    Whether the map rotates to match the player's heading.

    rotation?: number

    Manual rotation offset in radians.

    showCompass?: boolean

    Whether to display a north-facing compass needle.

    size?: number

    Pixel size of the map (square).

    zoom?: number

    Current zoom level (meters per pixel).

    Settings

    Member Visibility

    On This Page

    Properties