Interface IMinimapPropertyItem

A property item which supports Minimap properties

interface IMinimapPropertyItem {
    enable: boolean;
    id: string;
    mapId: string;
    mapImageHeight: number;
    mapImageWidth: number;
    paneId: string;
    typeName: PropertyItemType;
    visible: boolean;
    isMarkerTypeVisible(type: MinimapMarkerType): boolean;
    isMeMarkerShown(): boolean;
    registerCustomMarkerIcon(iconIdentifier: string, imagePath: string): void;
    resizeMapImage(width: number, height: number): void;
    setMarkerTypeVisible(type: MinimapMarkerType, visible: boolean): void;
    setMeMarkerShown(shown: boolean): void;
    unregisterCustomMarkerIcon(iconIdentifier: string): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IMinimapPropertyItem

Index

Properties

enable id mapId mapImageHeight mapImageWidth paneId typeName visible

Methods

isMarkerTypeVisible isMeMarkerShown registerCustomMarkerIcon resizeMapImage setMarkerTypeVisible setMeMarkerShown unregisterCustomMarkerIcon

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`mapId

mapId: string

Remarks

Id of the map.

`Readonly`mapImageHeight

mapImageHeight: number

Remarks

Height of the map image.

`Readonly`mapImageWidth

mapImageWidth: number

Remarks

Width of the map image.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

isMarkerTypeVisible

isMarkerTypeVisible(type: MinimapMarkerType): boolean
Parameters
- type: MinimapMarkerType
  The marker type to query.
Returns boolean
Remarks
Get visibility for a specific marker type.
- Defined in @minecraft/server-editor.d.ts:8694

isMeMarkerShown

isMeMarkerShown(): boolean
Returns boolean
Remarks
Get me marker visibility.
- Defined in @minecraft/server-editor.d.ts:8700

registerCustomMarkerIcon

registerCustomMarkerIcon(iconIdentifier: string, imagePath: string): void
Parameters
- iconIdentifier: string
  The iconIdentifier string.
- imagePath: string
  The image resource path.
Returns void
Remarks
Register a custom marker icon for UI rendering.
- Defined in @minecraft/server-editor.d.ts:8710

resizeMapImage

resizeMapImage(width: number, height: number): void
Parameters
- width: number
  New width of the image.
- height: number
  New height of the image.
Returns void
Remarks
Updates the size of the map image.
- Defined in @minecraft/server-editor.d.ts:8720

setMarkerTypeVisible

setMarkerTypeVisible(type: MinimapMarkerType, visible: boolean): void
Parameters
- type: MinimapMarkerType
  The marker type to toggle.
- visible: boolean
  Whether the marker type should be visible.
Returns void
Remarks
Set visibility for a specific marker type.
- Defined in @minecraft/server-editor.d.ts:8730

setMeMarkerShown

setMeMarkerShown(shown: boolean): void
Parameters
- shown: boolean
Returns void
Remarks
Set me marker visibility.
- Defined in @minecraft/server-editor.d.ts:8736

unregisterCustomMarkerIcon

unregisterCustomMarkerIcon(iconIdentifier: string): void
Parameters
- iconIdentifier: string
  The iconIdentifier string.
Returns void
Remarks
Unregister a custom marker icon.
- Defined in @minecraft/server-editor.d.ts:8744