Strata - v1.4.10
    Preparing search index...

    Interface MinimapProps

    Props for the Minimap component.

    Provides a top-down radar or map view with player tracking and interactive markers.

    interface MinimapProps {
        anchor?: UIAnchor;
        backgroundColor?: string;
        borderColor?: string;
        borderRadius?: number;
        borderWidth?: number;
        className?: string;
        fogOfWar?: boolean;
        followPlayer?: boolean;
        mapImage?: string;
        markers?: { id: string; position: [number, number]; type?: string }[];
        markerTypes?: Record<string, MinimapMarker>;
        playerColor?: string;
        playerIcon?: string;
        playerPosition?: [number, number];
        playerRotation?: number;
        playerSize?: number;
        rotateWithPlayer?: boolean;
        rotation?: number;
        showCompass?: boolean;
        size?: number;
        style?: CSSProperties;
        zoom?: number;
    }

    Hierarchy

    Index

    Properties

    anchor? backgroundColor? borderColor? borderRadius? borderWidth? className? fogOfWar? followPlayer? mapImage? markers? markerTypes? playerColor? playerIcon? playerPosition? playerRotation? playerSize? rotateWithPlayer? rotation? showCompass? size? style? zoom?

    Properties

    anchor?: UIAnchor

    Screen corner to anchor the minimap. Default: 'topRight'.

    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.

    className?: string

    Custom CSS class for the map container.

    fogOfWar?: boolean

    Whether to enable fog-of-war exploration.

    followPlayer?: boolean

    Whether the map centers on the player.

    mapImage?: string

    Path to a custom image for the map terrain.

    markers?: { id: string; position: [number, number]; type?: string }[]

    Array of interactive markers (POI) to display on the map.

    markerTypes?: Record<string, MinimapMarker>

    Definitions for custom marker types.

    playerColor?: string

    Color for the player indicator.

    playerIcon?: string

    Path to the player icon image.

    playerPosition?: [number, number]

    The player's current world coordinates [x, z].

    playerRotation?: number

    The player's current heading in radians.

    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).

    style?: CSSProperties

    Custom inline CSS styles.

    zoom?: number

    Current zoom level (meters per pixel).

    Settings

    Member Visibility

    On This Page

    Properties