#Class: MinimapItem experimental

Beta

A MinimapItem represents an individual minimap instance that manages map data, controls display state, and provides configuration for markers and visual properties.

#Properties

#freeCenter

readonly freeCenter: VectorXZ

Beta

---

#id

readonly id: string

Beta

---

#isActive

readonly isActive: boolean

Beta

#Remarks

Indicate whether this minimap instance is currently active and being displayed to the player.

---

#yLevel

readonly yLevel: number

Beta

#Methods

#addCustomMarker()

addCustomMarker(iconIdentifier, data, dimensionId): void

World Mutation Beta

#Parameters

#iconIdentifier

string

#data

MinimapMarkerData[]

#dimensionId

string

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#addLocationMarker()

addLocationMarker(data, dimensionId): void

World Mutation Beta

#Parameters

#data

MinimapMarkerData[]

#dimensionId

string

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#addMultiplayerMarker()

addMultiplayerMarker(): void

World Mutation Beta

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#getMarkerTypes()

getMarkerTypes(): MinimapMarkerType[]

Beta

#Returns

MinimapMarkerType[]

---

#getPlayerColor()

getPlayerColor(playerId): RGBA

Beta

#Parameters

#playerId

string

#Returns

RGBA

#Remarks

Retrieve the color assigned to a specific player on the minimap.

#Throws

This function can throw errors.

---

#hasCustomGroup()

hasCustomGroup(iconIdentifier): boolean

Beta

#Parameters

#iconIdentifier

string

#Returns

boolean

---

#hasMarkerOfType()

hasMarkerOfType(type): boolean

Beta

#Parameters

#type

MinimapMarkerType

#Returns

boolean

---

#removeAllCustomMarkers()

removeAllCustomMarkers(dimensionId): void

World Mutation Beta

#Parameters

#dimensionId

string

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#removeCustomMarker()

removeCustomMarker(iconIdentifier, dimensionId): void

World Mutation Beta

#Parameters

#iconIdentifier

string

#dimensionId

string

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#removeLocationMarker()

removeLocationMarker(dimensionId): void

World Mutation Beta

#Parameters

#dimensionId

string

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#removeMultiplayerMarker()

removeMultiplayerMarker(): void

World Mutation Beta

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#setActive()

setActive(active): void

World Mutation Beta

#Parameters

#active

boolean

#Returns

void

#Remarks

Control whether the minimap is currently active and visible to the player.

#Privilege

#Throws

This function can throw errors.

---

#setFreeCenter()

setFreeCenter(center): void

World Mutation Beta

#Parameters

#center

VectorXZ

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#setSize()

setSize(mapWidth, mapHeight): void

World Mutation Beta

#Parameters

#mapWidth

number

#mapHeight

number

#Returns

void

#Remarks

Adjust the width and height dimensions of the minimap display.

#Privilege

#Throws

This function can throw errors.

---

#setTrackingMode()

setTrackingMode(mode): void

World Mutation Beta

#Parameters

#mode

MinimapTrackingMode

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.

---

#setViewType()

setViewType(viewType): void

World Mutation Beta

#Parameters

#viewType

MinimapViewType

#Returns

void

#Remarks

Change the visual perspective or style of the minimap view.

#Privilege

#Throws

This function can throw errors.

---

#setYLevel()

setYLevel(yLevel): void

World Mutation Beta

#Parameters

#yLevel

number

#Returns

void

#Remarks

#Privilege

#Throws

This function can throw errors.