Class ProjectRegion

Constructors

`Private`constructor

new ProjectRegion(): ProjectRegion
Returns ProjectRegion

Properties

`Readonly`availabilityMode

availabilityMode: ProjectRegionAvailabilityMode

Throws

This property can throw errors.

World Ready

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

`Readonly`id

id: string

`Readonly`isValid

isValid: boolean

Methods

dispose

dispose(): boolean
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.

getAvailableLocationFromRay

getAvailableLocationFromRay(
    location: Vector3,
    direction: Vector3,
    options?: BlockRaycastOptions,
): Vector3
Parameters
- location: Vector3
- direction: Vector3
- Optionaloptions: BlockRaycastOptions
Returns Vector3
Throws
This function can throw errors.

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

getBlock

getBlock(location: Vector3): Block
Parameters
- location: Vector3
Returns Block
Throws
This function can throw errors.

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

getBlockMapColor

getBlockMapColor(location: Vector3): RGBA
Parameters
- location: Vector3
Returns RGBA
Throws
This function can throw errors.

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

getBlockPermutation

getBlockPermutation(location: Vector3): BlockPermutation
Parameters
- location: Vector3
Returns BlockPermutation
Throws
This function can throw errors.

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

getBlockTypeId

getBlockTypeId(location: Vector3): string
Parameters
- location: Vector3
Returns string
Throws
This function can throw errors.

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

getBounds

getBounds(): BlockBoundingBox
Returns BlockBoundingBox
Throws
This function can throw errors.

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

isAirBlock

isAirBlock(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Throws
This function can throw errors.

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

isAreaAvailable

isAreaAvailable(boundingBox: BlockBoundingBox): boolean
Parameters
- boundingBox: BlockBoundingBox
Returns boolean
Throws
This function can throw errors.

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

isAvailable

isAvailable(): boolean
Returns boolean
Throws
This function can throw errors.

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

isBlockWaterLogged

isBlockWaterLogged(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Throws
This function can throw errors.

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

isLiquidBlock

isLiquidBlock(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Throws
This function can throw errors.

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

isLocationAvailable

isLocationAvailable(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Throws
This function can throw errors.

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

isSolidBlock

isSolidBlock(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Throws
This function can throw errors.

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

requestBlockOperationArea

requestBlockOperationArea(
volume: RelativeVolumeListBlockVolume,
callback: (arg0: BlockLocationIterator) => void,
): Promise<void>
Parameters
- volume: RelativeVolumeListBlockVolume
- callback: (arg0: BlockLocationIterator) => void
Returns Promise<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.

requestExpandToContain

requestExpandToContain(
extentX: NumberRange,
extentZ: NumberRange,
): Promise<void>
Parameters
- extentX: NumberRange
- extentZ: NumberRange
Returns Promise<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.

requestExtentsUpdate

requestExtentsUpdate(extentX: NumberRange, extentZ: NumberRange): Promise<void>
Parameters
- extentX: NumberRange
- extentZ: NumberRange
Returns Promise<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.

requestMove

requestMove(center: Vector3): Promise<void>
Parameters
- center: Vector3
Returns Promise<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.

setBlockType

setBlockType(location: Vector3, blockType: string | BlockType): void
Parameters
- location: Vector3
- blockType: string | BlockType
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.

setBlockWaterlogged

setBlockWaterlogged(location: Vector3, isWaterlogged: boolean): void
Parameters
- location: Vector3
- isWaterlogged: 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.

spawnEntity

spawnEntity(
    identifier: string | EntityType,
    location: Vector3,
    rotation?: number,
): Entity
Parameters
- identifier: string | EntityType
- location: Vector3
- Optionalrotation: number
Returns Entity
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftserver.EntitySpawnError

Error

minecraftcommon.InvalidArgumentError

minecraftserver.InvalidEntityError

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

waitUntilAvailable

waitUntilAvailable(): Promise<void>
Returns Promise<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.

waitUntilBoundsAvailable

waitUntilBoundsAvailable(boundingBox: BlockBoundingBox): Promise<void>
Parameters
- boundingBox: BlockBoundingBox
Returns Promise<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.

Class ProjectRegion

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns ProjectRegion

Properties

ReadonlyavailabilityMode

Throws

World Ready

Readonlyid

ReadonlyisValid

Methods

dispose

Returns boolean

Remarks

Write Privilege

Throws

World Ready

getAvailableLocationFromRay

Parameters

Returns Vector3

Throws

World Ready

getBlock

Parameters

Returns Block

Throws

World Ready

getBlockMapColor

Parameters

Returns RGBA

Throws

World Ready

getBlockPermutation

Parameters

Returns BlockPermutation

Throws

World Ready

getBlockTypeId

Parameters

Returns string

Throws

World Ready

getBounds

Returns BlockBoundingBox

Throws

World Ready

isAirBlock

Parameters

Returns boolean

Throws

World Ready

isAreaAvailable

Parameters

Returns boolean

Throws

World Ready

isAvailable

Returns boolean

Throws

World Ready

isBlockWaterLogged

Parameters

Returns boolean

Throws

World Ready

isLiquidBlock

Parameters

Returns boolean

Throws

World Ready

isLocationAvailable

Parameters

Returns boolean

Throws

World Ready

isSolidBlock

`Private`constructor

`Readonly`availabilityMode

`Readonly`id

`Readonly`isValid