Class TickingAreaManager

Index

Constructors

Properties

chunkCount maxChunkCount

Methods

createTickingArea getAllTickingAreas getTickingArea hasCapacity hasTickingArea removeAllTickingAreas removeTickingArea

Constructors

`Private`constructor

new TickingAreaManager(): TickingAreaManager
Returns TickingAreaManager

Properties

`Readonly`chunkCount

chunkCount: number

`Readonly`maxChunkCount

maxChunkCount: number

Methods

createTickingArea

createTickingArea(
identifier: string,
options: TickingAreaOptions,
): Promise<void>
Parameters
- identifier: string
- options: TickingAreaOptions
Returns Promise<void>
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

TickingAreaError

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

getAllTickingAreas

getAllTickingAreas(): TickingArea[]
Returns TickingArea[]
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

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

getTickingArea

getTickingArea(identifier: string | TickingArea): TickingArea
Parameters
- identifier: string | TickingArea
Returns TickingArea
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

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

hasCapacity

hasCapacity(options: TickingAreaOptions): boolean
Parameters
- options: TickingAreaOptions
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

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

hasTickingArea

hasTickingArea(identifier: string): boolean
Parameters
- identifier: string
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

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

removeAllTickingAreas

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

Throws
This function can throw errors.

minecraftcommon.EngineError

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

removeTickingArea

removeTickingArea(identifier: string | TickingArea): void
Parameters
- identifier: string | TickingArea
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

TickingAreaError

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