Class MinimapItem

Index

Constructors

Properties

Methods

addMarker getPlayerColor removeMarker setActive setSize setViewType

Constructors

`Private`constructor

new MinimapItem(): MinimapItem
Returns MinimapItem

Properties

`Readonly`id

id: string

`Readonly`isActive

isActive: boolean

Methods

addMarker

addMarker(markerType: Multiplayer): void
Parameters
- markerType: Multiplayer
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getPlayerColor

getPlayerColor(playerId: string): RGBA
Parameters
- playerId: string
Returns RGBA
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

removeMarker

removeMarker(markerType: Multiplayer): void
Parameters
- markerType: Multiplayer
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setActive

setActive(active: boolean): void
Parameters
- active: boolean
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setSize

setSize(mapWidth: number, mapHeight: number): void
Parameters
- mapWidth: number
- mapHeight: number
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setViewType

setViewType(viewType: BlockView): void
Parameters
- viewType: BlockView
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.