The VoxelInteract class is used to interact with voxels in the World instance. It consists of two main parts:

• VoxelInteract.potential: The potential block placement. This is the data of a block's orientation that can be placed.
• VoxelInteract.target: The targeted block. This is the voxel that the camera is looking at.

You can use these two properties to place blocks, remove blocks, and more.

Example

// Create a new VoxelInteract instance.
const voxelInteract = new VoxelInteract(camera, world);

// Add the voxel interact to the scene.
world.add(voxelInteract);

// Set the target block to air.
if (voxelInteract.target) {
  const [vx, vy, vz] = voxelInteract.target;
  world.updateVoxel(vx, vy, vz, 0);
}

// Update the interaction every frame.
voxelInteract.update();

Hierarchy

• Group

  ↳ VoxelInteract

Constructors

constructor

• new VoxelInteract(object, world, options?): VoxelInteract

Create a new VoxelInteract instance.

Parameters

Name	Type	Description
object	Object3D<Object3DEventMap>	The object that the interactions should be raycasting from.
world	World<any>	The World instance that the interactions should be raycasting in.
options	Partial<VoxelInteractOptions>	Parameters to customize the VoxelInteract instance.

Returns

VoxelInteract

Overrides

Group.constructor

Properties

active

• active: boolean = true

Whether or not is this VoxelInteract instance currently active.

---

object

• object: Object3D<Object3DEventMap>

The object that the interactions should be raycasting from.

---

options

• options: VoxelInteractOptions

Parameters to customize the VoxelInteract instance.

---

potential

• potential: Object

The potential orientation and location of the block placement. If no block placement is possible, this will be null.

Type declaration

Name	Type	Description
placement	{ facingPlayerRotation: number ; facingPlayerYRotation: number ; facingPlayerYRotation4: number ; facingPlayerYRotation8: number ; verticalHalf: "bottom" | "top" }	Additional placement hints derived from the raycast hit point and player position. Useful for blocks like slabs (top/bottom) and signs (facing player).
placement.facingPlayerRotation	number	The rotation value that would make the block face toward the player. Useful for signs, paintings, and other wall-mounted blocks.
placement.facingPlayerYRotation	number	The Y-rotation value (16 segments) that would make the block face toward the player.
placement.facingPlayerYRotation4	number	The Y-rotation value (4 segments) that would make the block face toward the player.
placement.facingPlayerYRotation8	number	The Y-rotation value (8 segments) that would make the block face toward the player.
placement.verticalHalf	"bottom" | "top"	Whether the hit point is in the top or bottom half of the target voxel space. Useful for determining slab placement (top slab vs bottom slab).
rotation	number	The rotation that the block placement's major axis should be facing.
voxel	Coords3	The 3D coordinates of the potential block placement.
yRotation	number	The rotation along the Y axis that the block placement's major axis should be facing. This only works if rotation is PY_ROTATION or NY_ROTATION.
yRotation4	number	-
yRotation8	number	-

---

target

• target: Coords3

The targeted voxel coordinates of the block that the camera is looking at. If no block is targeted, this will be null.

---

world

• world: World<any>

The World instance that the interactions should be raycasting in.

Accessors

lookingAt

• get lookingAt(): Block

Get the voxel ID of the targeted voxel. null if no voxel is targeted.

Returns

Block

Methods

getAABBOverride

▸ getAABBOverride(voxel): AABB[]

Parameters

Name	Type
voxel	Coords3

Returns

AABB[]

---

removeAABBOverride

▸ removeAABBOverride(voxel): void

Parameters

Name	Type
voxel	Coords3

Returns

void

---

setAABBOverride

▸ setAABBOverride(voxel, aabbs, owner?): void

Parameters

Name	Type
voxel	Coords3
aabbs	AABB[]
owner?	Coords3

Returns

void

---

toggle

▸ toggle(force?): void

Parameters

Name	Type	Default value
force	boolean	null

Returns

void

---

update

▸ update(): void

Raycasts from the given object's position and direction to find the targeted voxel and potential block placement. If no block is targeted, then VoxelInteract.target and VoxelInteract.potential will both be null.

Returns

void