Class PlayerProjectRegionManager

Index

Constructors

Methods

disposeAllRegions disposeRegion getCursorRegion getSelectionRegion leaseRegion

Constructors

`Private`constructor

new PlayerProjectRegionManager(): PlayerProjectRegionManager
Returns PlayerProjectRegionManager

Methods

disposeAllRegions

disposeAllRegions(): void
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.

disposeRegion

disposeRegion(id: string): boolean
Parameters
- id: string
Returns boolean
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.

getCursorRegion

getCursorRegion(): ProjectRegion
Returns ProjectRegion
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.

getSelectionRegion

getSelectionRegion(): ProjectRegion
Returns ProjectRegion
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.

leaseRegion

leaseRegion(options: ProjectRegionOptions): ProjectRegion
Parameters
- options: ProjectRegionOptions
Returns ProjectRegion
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.