Class BlockUtil`Abstract`

Index

Constructors

Methods

getBlockSafe getAdjacentBlock isBlockLoaded getPlacementPosFromRayHit getHighestAirBlock getNeighborBlockType hasNeighbor serializeBlockLocation deserializeBlockLocation

Constructors

constructor

new BlockUtil(): BlockUtil
Returns BlockUtil

Methods

`Static`getBlockSafe

getBlockSafe(dimension: Dimension, location: Vec3 | Vector3): Block | undefined
Safely fetches a block at the given location.
Parameters
- dimension: Dimension
  The target Dimension.
- location: Vec3 | Vector3
  World position as a native Vector3 or Vec3.
Returns Block | undefined
The Block if available; otherwise undefined on error or if the block is not loaded.
Example
```
const block = BlockUtil.getBlockSafe(player.dimension, player.location);
if (block) DevUtil.logAll("Debug", block.typeId);
```
Remarks
- Internally calls dimension.getBlock. Any exceptions are caught and logged via DevUtil.
- If location is a Vec3, its .unwrap() is used.
- Defined in src/utils/block_util.ts:32

`Static`getAdjacentBlock

getAdjacentBlock(block: Block, direction: Direction): Block | undefined
Returns the block adjacent to the given block in a specific direction.
Parameters
- block: Block
  The reference Block.
- direction: Direction
  The Direction (face) to query (Up/Down/North/South/East/West).
Returns Block | undefined
The neighbor block if available; otherwise undefined.
Example
```
const above = BlockUtil.getAdjacentBlock(block, Direction.Up);
```
Remarks
- Uses getBlockSafe under the hood to avoid throwing on unloaded chunks.
- Non-cardinal directions (if ever added) will return undefined.
- Defined in src/utils/block_util.ts:57

`Static`isBlockLoaded

isBlockLoaded(location: Vec3, dimension: Dimension): boolean
Checks if a block at the given location is currently loaded and valid.
Parameters
- location: Vec3
  The block position as Vec3.
- dimension: Dimension
  The target Dimension.
Returns boolean
true if the block exists and block.isValid is truthy; otherwise false.
Example
```
if (BlockUtil.isBlockLoaded(pos, player.dimension)) {
  // safe to read or modify
}
```
Remarks
- Wraps dimension.getBlock in a try/catch and profiles via DebugTimerUtil.
- Defined in src/utils/block_util.ts:96

`Static`getPlacementPosFromRayHit

getPlacementPosFromRayHit(
rayHit: BlockRaycastHit,
yaw: number,
): Vec3 | undefined
Parameters
- rayHit: BlockRaycastHit
- yaw: number
Returns Vec3 | undefined
- Defined in src/utils/block_util.ts:109

`Static`getHighestAirBlock

getHighestAirBlock(
    dimension: Dimension,
    location: Vec3 | Readonly<{ x: number; y: number; z: number }>,
    options?: HighestAirOptions,
): Readonly<{ x: number; y: number; z: number }> | null
Finds the highest air (or optionally water) block at X/Z by scanning from maxY down to minY.
Parameters
- dimension: Dimension
  The target Dimension.
- location: Vec3 | Readonly<{ x: number; y: number; z: number }>
  The X and Z to probe, as Vec3 or BlockPos.
- Optionaloptions: HighestAirOptions
  Scan options; see HighestAirOptions.
Returns Readonly<{ x: number; y: number; z: number }> | null
A BlockPos where the highest matching block is found, or null if none in range.
Example
```
const spawn = BlockUtil.getHighestAirBlock(player.dimension, player.location, { maxY: 320 });
if (spawn) player.teleport(spawn);
```
Remarks
- Default range is minY = 0 to maxY = 320.
- If includeWater is true, "minecraft:water" and "minecraft:flowing_water" are treated as air.
- Performance scales with (maxY - minY); constrain the range when possible.
- Defined in src/utils/block_util.ts:138

`Static`getNeighborBlockType

getNeighborBlockType(block: Block, typeId: string): NeighborMask
Builds a bitmask of cardinal neighbors (N/E/S/W) whose type matches typeId.
Parameters
- block: Block
  The center Block.
- typeId: string
  A block type ID to compare against (e.g., "minecraft:stone").
Returns NeighborMask
A NeighborMask bitmask (combine with &/|).
Example
```
const mask = BlockUtil.getNeighborBlockType(block, "minecraft:oak_fence");
if (BlockUtil.hasNeighbor(mask, Direction.North)) {
  // connected north
}
```
Remarks
- Uses DebugTimerUtil profiling.
- Only cardinal directions are considered. Diagonals are not included.
- Defined in src/utils/block_util.ts:177

`Static`hasNeighbor

hasNeighbor(mask: NeighborMask, dir: Direction): boolean
Tests whether a neighbor in the given direction is present in a NeighborMask.
Parameters
- mask: NeighborMask
  The bitmask from BlockUtil.getNeighborBlockType.
- dir: Direction
  The Direction to test (North/East/South/West).
Returns boolean
true if the corresponding bit is set; otherwise false.
Example
```
if (BlockUtil.hasNeighbor(mask, Direction.West)) {
  // west neighbor matches
}
```
Remarks
- Non-cardinal directions (e.g., Up/Down) return false.
- Defined in src/utils/block_util.ts:216

`Static`serializeBlockLocation

serializeBlockLocation(location: BlockPos): `${number},${number},${number}`
Converts a block position into a canonical key string "x,y,z".
Parameters
- location: BlockPos
Returns `${number},${number},${number}`
- Defined in src/utils/block_util.ts:222
serializeBlockLocation(location: { x: number; y: number; z: number }): string
Converts a block position into a canonical key string "x,y,z".
Parameters
- location: { x: number; y: number; z: number }
Returns string
- Defined in src/utils/block_util.ts:223

`Static`deserializeBlockLocation

deserializeBlockLocation(locKey: `${number},${number},${number}`): BlockPos
Parses a canonical key string "x,y,z" back into a block position object.
Parameters
- locKey: `${number},${number},${number}`
Returns BlockPos
- Defined in src/utils/block_util.ts:229
deserializeBlockLocation(locKey: string): { x: number; y: number; z: number }
Parses a canonical key string "x,y,z" back into a block position object.
Parameters
- locKey: string
Returns { x: number; y: number; z: number }
- Defined in src/utils/block_util.ts:230

Class BlockUtilAbstract

Index

Constructors

Methods

Constructors

constructor

Returns BlockUtil

Methods

StaticgetBlockSafe

Parameters

Returns Block | undefined

Example

Remarks

StaticgetAdjacentBlock

Parameters

Returns Block | undefined

Example

Remarks

StaticisBlockLoaded

Parameters

Returns boolean

Example

Remarks

StaticgetPlacementPosFromRayHit

Parameters

Returns Vec3 | undefined

StaticgetHighestAirBlock

Parameters

Returns Readonly<{ x: number; y: number; z: number }> | null

Example

Remarks

StaticgetNeighborBlockType

Parameters

Returns NeighborMask

Example

Remarks

StatichasNeighbor

Parameters

Returns boolean

Example

Remarks

StaticserializeBlockLocation

Parameters

Returns `${number},${number},${number}`

Parameters

Returns string

StaticdeserializeBlockLocation

Parameters

Returns BlockPos

Parameters

Returns { x: number; y: number; z: number }

Settings

On This Page

Class BlockUtil`Abstract`

`Static`getBlockSafe

`Static`getAdjacentBlock

`Static`isBlockLoaded

`Static`getPlacementPosFromRayHit

`Static`getHighestAirBlock

`Static`getNeighborBlockType

`Static`hasNeighbor

`Static`serializeBlockLocation

`Static`deserializeBlockLocation