Class ProjectRegionManager

Index

Constructors

Properties

isProcessingChunks

Methods

getChunkProcessingState pruneRegion regenerateRegion

Constructors

`Private`constructor

new ProjectRegionManager(): ProjectRegionManager
Returns ProjectRegionManager

Properties

`Readonly`isProcessingChunks

isProcessingChunks: boolean

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

Methods

getChunkProcessingState

getChunkProcessingState(): ProjectRegionManagerChunkProcessingState
Returns ProjectRegionManagerChunkProcessingState
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.

pruneRegion

pruneRegion(
dimensionId: string,
boundsList: ProjectRegionExtents[],
): Promise<ProjectRegionManagerChunkProcessingState>
Parameters
- dimensionId: string
- boundsList: ProjectRegionExtents[]
Returns Promise<ProjectRegionManagerChunkProcessingState>
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.

regenerateRegion

regenerateRegion(
    dimensionId: string,
    boundsList: ProjectRegionExtents[],
    areBoundsExcluded: boolean,
): Promise<ProjectRegionManagerChunkProcessingState>
Parameters
- dimensionId: string
- boundsList: ProjectRegionExtents[]
- areBoundsExcluded: boolean
Returns Promise<ProjectRegionManagerChunkProcessingState>
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.