MiniMaps

A component that manages multiple MiniMap instances, each associated with a unique world ID. 📕 Tutorial. 📘 API.

Extends

• Component

Implements

• Updateable
• Disposable

Properties

enabled

enabled: boolean = true

Component.enabled

Overrides

Component . enabled

---

list

list: Map<string, MiniMap>

A collection of MiniMap instances, each associated with a unique world ID.

---

onAfterUpdate

readonly onAfterUpdate: Event<unknown>

Updateable.onAfterUpdate

Implementation of

Updateable . onAfterUpdate

---

onBeforeUpdate

readonly onBeforeUpdate: Event<unknown>

Updateable.onBeforeUpdate

Implementation of

Updateable . onBeforeUpdate

---

onDisposed

readonly onDisposed: Event<unknown>

Disposable.onDisposed

Implementation of

Disposable . onDisposed

---

onSetup

readonly onSetup: Event<unknown>

Configurable.onSetup

---

uuid

static readonly uuid: "39ad6aad-84c8-4adf-a1e0-7f25313a9e7f"

A unique identifier for the component. This UUID is used to register the component within the Components system.

Methods

create()

create(world): MiniMap

Creates a new MiniMap instance associated with the given world. If a MiniMap instance already exists for the given world, an error will be thrown.

Parameters

Parameter	Type	Description
world	World	The World for which to create a MiniMap instance.

Returns

MiniMap

The newly created MiniMap instance.

Throws

Will throw an error if a MiniMap instance already exists for the given world.

---

delete()

delete(id): void

Deletes a MiniMap instance associated with the given world ID. If a MiniMap instance does not exist for the given ID, nothing happens.

Parameters

Parameter	Type	Description
id	string	The unique identifier of the world for which to delete the MiniMap instance.

Returns

void

---

dispose()

dispose(): void

Disposable.dispose

Returns

void

Implementation of

Disposable . dispose

---

isConfigurable()

isConfigurable(): this is Configurable<any, any>

Whether is component is Configurable.

Returns

this is Configurable<any, any>

Inherited from

Component . isConfigurable

---

isDisposeable()

isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns

this is Disposable

Inherited from

Component . isDisposeable

---

isHideable()

isHideable(): this is Hideable

Whether is component is Hideable.

Returns

this is Hideable

Inherited from

Component . isHideable

---

isResizeable()

isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns

this is Resizeable

Inherited from

Component . isResizeable

---

isUpdateable()

isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns

this is Updateable

Inherited from

Component . isUpdateable

---

update()

update(): void

Updateable.update

Returns

void

Implementation of

Updateable . update