@voxelize/core

Enumerations

• BlockRuleLogic

Core Classes

• Chat
• Entities
• Inputs
• Loader
• MobileRigidControls
• Network
• Peers
• RigidControls
• World

Effects Classes

• BlockOverlayEffect
• ColorText
• LightShined

Other Classes

• AnimationUtils
• Arm
• Arrow
• AtlasTexture
• BlockRotation
• BoxLayer
• CanvasBox
• Character
• Chunk
• Clouds
• Debug
• Entity
• Events
• FaceAnimation
• ItemSlot
• ItemSlots
• Method
• NameTag
• Perspective
• Portrait
• Registry
• Shadow
• Shadows
• SharedWorkerPool
• Sky
• SpriteText
• ThreeUtils
• VoxelInteract
• WorkerPool

Utils Classes

• BlockUtils
• ChunkUtils
• DOMUtils
• LightUtils
• MathUtils

Interfaces

• BlockConditionalPart
• BlockDynamicPattern
• NetIntercept

Type Aliases

ArmOptions

Ƭ ArmOptions: Object

Type declaration

Name	Type
armColor?	string | THREE.Color
armObject?	THREE.Object3D
armObjectOptions	ArmObjectOptions
armTexture?	THREE.Texture
blockObjectOptions?	ArmObjectOptions
customObjectOptions?	Record<string, ArmObjectOptions>

---

ArmsOptions

Ƭ ArmsOptions: ColorCanvasBoxOptions & { shoulderDrop?: number ; shoulderGap?: number }

Parameters to create a character's arms. Defaults to:

{
  gap: 0.1 * CHARACTER_SCALE,
  layers: 1,
  side: THREE.DoubleSide,
  width: 0.25 * CHARACTER_SCALE,
  widthSegments: 8,
  height: 0.5 * CHARACTER_SCALE,
  heightSegments: 16,
  depth: 0.25 * CHARACTER_SCALE,
  depthSegments: 8,
  shoulderGap: 0.05 * CHARACTER_SCALE,
  shoulderDrop: 0.25 * CHARACTER_SCALE,
}

---

ArrowOptions

Ƭ ArrowOptions: Object

Parameters to create an arrow.

Type declaration

Name	Type	Description
color	string | Color	The color of the arrow. Defaults to red.
coneHeight	number	The height of the head of the arrow. Defaults to 0.2.
coneRadius	number	The radius of the head of the arrow. Defaults to 0.2.
height	number	The height of the body of the arrow. Defaults to 0.8.
radius	number	The radius of the body of the arrow. Defaults to 0.1.

---

ArtFunction

Ƭ ArtFunction: (context: CanvasRenderingContext2D, canvas: HTMLCanvasElement) => void

A function to programmatically draw on a canvas.

Type declaration

▸ (context, canvas): void

Parameters

Name	Type
context	CanvasRenderingContext2D
canvas	HTMLCanvasElement

Returns

void

---

Block

Ƭ Block: Object

A block type in the world. This is defined by the server.

Type declaration

Name	Type	Description
aabbs	AABB[]	A list of axis-aligned bounding boxes that this block has.
blueLightLevel	number	The blue light level of the block.
dynamicFn	(pos: Coords3) => { aabbs: Block["aabbs"] ; faces: Block["faces"] ; isTransparent: Block["isTransparent"] }	-
dynamicPatterns	BlockDynamicPattern[]	-
faces	{ corners: { pos: [number, number, number] ; uv: number[] }[] ; dir: [number, number, number] ; independent: boolean ; isolated: boolean ; name: string ; range: UV }[]	A list of block face data that this block has.
greenLightLevel	number	The green light level of the block.
id	number	The block id.
independentFaces	Set<string>	A set of block face names that are independent (high resolution or animated). This is generated on the client side.
isDynamic	boolean	Whether or not does the block generate dynamic faces or AABB's. If this is true, the block will use dynamicFn to generate the faces and AABB's.
isEmpty	boolean	Whether or not is this block empty. By default, only "air" is empty.
isEntity	boolean	-
isFluid	boolean	Whether or not is the block a fluid block.
isLight	boolean	Whether or not is this block a light source.
isOpaque	boolean	Whether or not is this block opaque (not transparent).
isPassable	boolean	Whether or not should physics ignore this block.
isSeeThrough	boolean	Whether or not is this block see-through (can be opaque and see-through at the same time).
isTransparent	[boolean, boolean, boolean, boolean, boolean, boolean]	Whether or not is this block transparent viewing from all six sides. The sides are defined as PX, PY, PZ, NX, NY, NZ.
isolatedFaces	Set<string>	-
lightReduce	boolean	Whether or not should light reduce by 1 going through this block.
name	string	The name of the block.
redLightLevel	number	The red light level of the block.
rotatable	boolean	Whether or not is the block rotatable.
transparentStandalone	boolean	-
yRotatable	boolean	Whether or not the block is rotatable around the y-axis (has to face either PX or NX).
yRotatableSegments	"All" | "Eight" | "Four"	-

---

BlockEntityUpdateData

Ƭ BlockEntityUpdateData<T>: Object

Type parameters

Name
T

Type declaration

Name	Type
etype	string
id	string
newValue	T | null
oldValue	T | null
operation	EntityOperation
voxel	Coords3

---

BlockEntityUpdateListener

Ƭ BlockEntityUpdateListener<T>: (args: BlockEntityUpdateData<T>) => void

Type parameters

Name
T

Type declaration

▸ (args): void

Parameters

Name	Type
args	BlockEntityUpdateData<T>

Returns

void

---

BlockRule

Ƭ BlockRule: { type: "none" } | { type: "simple" } & BlockSimpleRule | { logic: BlockRuleLogic ; rules: BlockRule[] ; type: "combination" }

---

BlockSimpleRule

Ƭ BlockSimpleRule: Object

Type declaration

Name	Type
id?	number
offset	Coords3
rotation?	BlockRotation
stage?	number

---

BlockUpdate

Ƭ BlockUpdate: Object

A block update to make on the server.

Type declaration

Name	Type	Description
rotation?	number	The optional rotation of the updated block.
stage?	number	The optional stage of the updated block.
type	number	The voxel type.
vx	number	The voxel x-coordinate.
vy	number	The voxel y-coordinate.
vz	number	The voxel z-coordinate.
yRotation?	number	The optional y-rotation of the updated block.

---

BlockUpdateListener

Ƭ BlockUpdateListener: (args: { newValue: number ; oldValue: number ; voxel: Coords3 }) => void

Type declaration

▸ (args): void

Parameters

Name	Type
args	Object
args.newValue	number
args.oldValue	number
args.voxel	Coords3

Returns

void

---

BlockUpdateWithSource

Ƭ BlockUpdateWithSource: Object

Type declaration

Name	Type
source	"client" | "server"
update	BlockUpdate

---

BodyOptions

Ƭ BodyOptions: ColorCanvasBoxOptions

Parameters to create a character's body. Defaults to:

{
  gap: 0.1 * CHARACTER_SCALE,
  layers: 1,
  side: THREE.DoubleSide,
  width: 1 * CHARACTER_SCALE,
  widthSegments: 16,
}

where CHARACTER_SCALE is 0.9.

---

BoundingBox

Ƭ BoundingBox: Object

Type declaration

Name	Type
min	Coords3
shape	Coords3

---

BoxSides

Ƭ BoxSides: "back" | "front" | "top" | "bottom" | "left" | "right" | "sides" | "all"

The sides of a canvas box.

"all" means all six sides, and "sides" means all the sides except the top and bottom.

---

CSSMeasurement

Ƭ CSSMeasurement: `${number}${string}`

A CSS measurement. E.g. "30px", "51em"

---

CameraPerspective

Ƭ CameraPerspective: "px" | "nx" | "py" | "ny" | "pz" | "nz" | "pxy" | "nxy" | "pxz" | "nxz" | "pyz" | "nyz" | "pxyz" | "nxyz"

---

CanvasBoxOptions

Ƭ CanvasBoxOptions: Object

Parameters to create a canvas box.

Type declaration

Name	Type	Description
depth?	number	The depth of the box. Defaults to whatever width is.
depthSegments?	number	The depth segments of the box, which is the number of pixels of the canvases along the depth. Defaults to whatever widthSegments is.
gap	number	The gap between the layers of the box. Defaults to 0.
height?	number	The height of the box. Defaults to whatever width is.
heightSegments?	number	The height segments of the box, which is the number of pixels of the canvases along the height. Defaults to whatever widthSegments is.
layers	number	The number of layers of this box. Defaults to 1.
side	Side	The side of the box to render. Defaults to THREE.FrontSide.
transparent?	boolean	Whether or not should this canvas box be rendered as transparent. Defaults to false.
width	number	THe width of the box. Defaults to 1.
widthSegments	number	The width segments of the box, which is the number of pixels of the canvases along the width. Defaults to 8.

---

CharacterOptions

Ƭ CharacterOptions: Object

Parameters to create a character.

Type declaration

Name	Type	Description
arms?	Partial<ArmsOptions>	Parameters to create the character's arms.
body?	Partial<BodyOptions>	Parameters to create the character's body.
head?	Partial<HeadOptions>	Parameters to create the character's head.
idleArmSwing?	number	The speed at which the arms swing when the character is idle. Defaults to 0.06.
legs?	Partial<LegOptions>	Parameters to create the character's legs.
nameTagOptions?	Partial<NameTagOptions>	-
positionLerp?	number	The lerp factor of the character's position change. Defaults to 0.7.
rotationLerp?	number	The lerp factor of the character's rotation change. Defaults to 0.2.
swingLerp?	number	The lerp factor of the swinging motion of the arms and legs. Defaults to 0.8.
walkingSpeed?	number	The speed at which the arms swing when the character is moving. Defaults to 1.4.

---

ChunkDataEventData

Ƭ ChunkDataEventData: Object

Type declaration

Name	Type
chunk	Chunk
coords	Coords2

---

ChunkEventData

Ƭ ChunkEventData: Object

Type declaration

Name	Type
allMeshes	Map<number, Mesh[]>
chunk	Chunk
coords	Coords2

---

ChunkMeshEventData

Ƭ ChunkMeshEventData: Object

Type declaration

Name	Type
chunk	Chunk
coords	Coords2
level	number
meshes	Mesh[]

---

ChunkMeshUpdateEventData

Ƭ ChunkMeshUpdateEventData: ChunkMeshEventData & { reason: ChunkUpdateReason }

---

ChunkUpdateEventData

Ƭ ChunkUpdateEventData: ChunkEventData & { reason: ChunkUpdateReason }

---

ChunkUpdateReason

Ƭ ChunkUpdateReason: "voxel" | "light"

---

ClickType

Ƭ ClickType: "left" | "middle" | "right"

Three types of clicking for mouse input listening.

---

CloudsOptions

Ƭ CloudsOptions: Object

Parameters used to create a new Clouds instance.

Type declaration

Name	Type	Description
alpha	number	The opacity of the clouds. Defaults to 0.8.
cloudHeight	number	The y-height at which the clouds are generated. Defaults to 256.
color	string	The color of the clouds. Defaults to #fff.
count	number	The number of cloud cells to generate, count * count. Defaults to 16.
dimensions	Coords3	The dimension of each cloud block. Defaults to [20, 20, 20].
falloff	number	The noise falloff factor used to generate the clouds. Defaults to 0.9.
height	number	The vertical count of how many cloud blocks are in a cloud cell. This is also used to determine the overall count of cloud blocks of all the clouds. Defaults to 3.
lerpFactor	number	The lerp factor used to translate cloud blocks from their original position to their new position. Defaults to 0.3.
noiseScale	number	The scale of the noise used to generate the clouds. Defaults to 0.08.
octaves	number	The number of octaves used to generate the noise. Defaults to 5.
seed	number	The seed used to generate the clouds. Defaults to -1.
speedFactor	number	The speed at which the clouds move. Defaults to 8.
threshold	number	The threshold at which noise values are considered to be "cloudy" and should generate a new cloud block. Defaults to 0.05.
uFogColor?	{ value: Color }	An object that is used as the uniform for the clouds fog color shader.
uFogColor.value	Color	-
uFogFar?	{ value: number }	An object that is used as the uniform for the clouds fog far shader.
uFogFar.value	number	-
uFogNear?	{ value: number }	An object that is used as the uniform for the clouds fog near shader.
uFogNear.value	number	-
width	number	The horizontal count of how many cloud blocks are in a cloud cell. Defaults to 8.

---

CommandInfo

Ƭ CommandInfo: Object

Information about a command including its processor and documentation.

Type declaration

Name	Type
aliases	string[]
category?	string
description	string
flags	string[]
process	CommandProcessor

---

CommandOptions

Ƭ CommandOptions: Object

Options for adding a command.

Type declaration

Name	Type
aliases?	string[]
category?	string
description?	string
flags?	string[]

---

CommandProcessor

Ƭ CommandProcessor: (rest: string) => void

A process that gets run when a command is triggered.

Type declaration

▸ (rest): void

Parameters

Name	Type
rest	string

Returns

void

---

Coords2

Ƭ Coords2: [number, number]

---

Coords3

Ƭ Coords3: [number, number, number]

---

CullOptionsType

Ƭ CullOptionsType: Object

Type declaration

Name	Type
dimensions	Coords3
max	Coords3
min	Coords3
realMax	Coords3
realMin	Coords3

---

CustomChunkShaderMaterial

Ƭ CustomChunkShaderMaterial: ShaderMaterial & { map: Texture }

Custom shader material for chunks, simply a ShaderMaterial from ThreeJS with a map texture. Keep in mind that if you want to change its map, you also have to change its uniforms.map.

---

DebugOptions

Ƭ DebugOptions: Object

Parameters to create a Debug instance.

Type declaration

Name	Type	Description
asyncPeriod	number	-
containerId	string	-
dataClass	string	A class to add to the wrapper of the top-left debug panel.
dataStyles	Partial<CSSStyleDeclaration>	Styles to apply to the wrapper of the top-left debug panel.
entriesClass	string	A class to add to the wrapper of all debug entries.
entriesStyles	Partial<CSSStyleDeclaration>	Styles to apply to the wrapper of all debug entries.
lineClass	string	A class to add to each of the debug entry line (top left).
lineStyles	Partial<CSSStyleDeclaration>	Styles to apply to each of the debug entry line (top left).
newLineStyles	Partial<CSSStyleDeclaration>	-
onByDefault	boolean	Whether or not should the debug panel be displayed by default when the page loads. Defaults to true. You can toggle the debug panel by calling Debug.toggle.
showVoxelize	boolean	Whether or not should Voxelize x.x.x be displayed in the top-left debug panel. Defaults to true.
stats	boolean	Whether or not should stats.js be enabled. Defaults to true.
statsStyles	Partial<CSSStyleDeclaration>	-

---

DeepPartial

Ƭ DeepPartial<T>: { [P in keyof T]?: DeepPartial<T[P]> }

Type parameters

Name
T

---

Event

Ƭ Event: Object

A Voxelize event from the server.

Type declaration

Name	Type	Description
name	string	The name to identify the event.
payload?	any	Additional information of the event.

---

EventHandler

Ƭ EventHandler: (payload: any | null) => void

The handler for an event sent from the Voxelize server.

Type declaration

▸ (payload): void

Parameters

Name	Type
payload	any | null

Returns

void

---

HeadOptions

Ƭ HeadOptions: ColorCanvasBoxOptions & { faceColor: Color | string ; neckGap?: number }

---

InputOccasion

Ƭ InputOccasion: "keydown" | "keypress" | "keyup"

The occasion that the input should be fired.

---

InputSpecifics

Ƭ InputSpecifics: Object

The specific options of the key to listen to.

Type declaration

Name	Type	Description
checkType?	"key" | "code"	The type of key to check for. Defaults to key.
identifier?	string	A special identifier to tag this input with. This is useful for removing specific inputs from the input listener later on.
occasion?	InputOccasion	The occasion that the input should be fired. Defaults to keydown.

---

ItemSlotsOptions

Ƭ ItemSlotsOptions: Object

Type declaration

Name	Type
activatedByDefault	boolean
focusFirstByDefault	boolean
horizontalCount	number
perspective	CameraPerspective
scrollable?	boolean
slotClass	string
slotFocusClass	string
slotGap	number
slotHeight	number
slotHoverClass	string
slotMargin	number
slotPadding	number
slotStyles	Partial<CSSStyleDeclaration>
slotSubscriptClass	string
slotSubscriptStyles	Partial<CSSStyleDeclaration>
slotWidth	number
verticalCount	number
wrapperClass	string
wrapperPadding	number
wrapperStyles	Partial<CSSStyleDeclaration>
zoom	number

---

LegOptions

Ƭ LegOptions: ColorCanvasBoxOptions & { betweenLegsGap?: number }

Parameters to create the legs of a character. Defaults to:

{
  gap: 0.1 * CHARACTER_SCALE,
  layers: 1,
  side: THREE.DoubleSide,
  width: 0.25 * CHARACTER_SCALE,
  widthSegments: 3,
  height: 0.25 * CHARACTER_SCALE,
  heightSegments: 3,
  depth: 0.25 * CHARACTER_SCALE,
  depthSegments: 3,
  betweenLegsGap: 0.2 * CHARACTER_SCALE,
}

where CHARACTER_SCALE is 0.9.

---

LightColor

Ƭ LightColor: "RED" | "GREEN" | "BLUE" | "SUNLIGHT"

Sunlight or the color of torch light.

---

LightJob

Ƭ LightJob: Object

Type declaration

Name	Type
boundingBox	BoundingBox
color	LightColor
jobId	string
lightOps	{ floods: LightNode[] ; removals: Coords3[] }
lightOps.floods	LightNode[]
lightOps.removals	Coords3[]
retryCount	number
startSequenceId	number

---

LightNode

Ƭ LightNode: Object

Type declaration

Name	Type
level	number
voxel	Coords3

---

LightOperations

Ƭ LightOperations: Object

Type declaration

Name	Type
floods	{ blue: LightNode[] ; green: LightNode[] ; red: LightNode[] ; sunlight: LightNode[] }
floods.blue	LightNode[]
floods.green	LightNode[]
floods.red	LightNode[]
floods.sunlight	LightNode[]
hasOperations	boolean
removals	{ blue: Coords3[] ; green: Coords3[] ; red: Coords3[] ; sunlight: Coords3[] }
removals.blue	Coords3[]
removals.green	Coords3[]
removals.red	Coords3[]
removals.sunlight	Coords3[]

---

LightShinedOptions

Ƭ LightShinedOptions: Object

Parameters to create a light shine effect.

Type declaration

Name	Type	Description
lerpFactor	number	The lerping factor of the brightness of each mesh. Defaults to 0.1.
maxBrightness	number	The maximum brightness cap for the light effect. Defaults to 1.2.

---

LightWorkerResult

Ƭ LightWorkerResult: Object

Type declaration

Name	Type
appliedDeltas	{ lastSequenceId: number }
appliedDeltas.lastSequenceId	number
jobId	string
modifiedChunks	{ coords: Coords2 ; lights: Uint32Array }[]

---

MeshResultType

Ƭ MeshResultType: Object

Type declaration

Name	Type
indices	Float32Array
normals	Float32Array
positions	Float32Array

---

NameTagOptions

Ƭ NameTagOptions: Object

Parameters to create a name tag.

Type declaration

Name	Type	Description
backgroundColor?	string	The background color of the name tag. Defaults to 0x00000077.
color?	string	The color of the name tag. Defaults to 0xffffff.
fontFace?	string	The font face to create the name tag. Defaults to "monospace".
fontSize?	number	The font size to create the name tag. Defaults to 0.1.
yOffset?	number	The y-offset of the nametag moved upwards. Defaults to 0.

---

NetworkConnectionOptions

Ƭ NetworkConnectionOptions: Object

Parameters to customize the connection to a Voxelize server. For example, setting a secret key to authenticate the connection with the server.

Type declaration

Name	Type	Description
reconnectTimeout?	number	On disconnection, the timeout to attempt to reconnect. Defaults to 5000.
secret?	string	The secret to joining a server, a key that if set on the server, then must be provided to connect to the server successfully.

---

NetworkOptions

Ƭ NetworkOptions: Object

Type declaration

Name	Type
maxPacketsPerTick	number

---

PartialRecord

Ƭ PartialRecord<K, T>: { [P in K]?: T }

Type parameters

Name	Type
K	extends keyof any
T	T

---

PeersOptions

Ƭ PeersOptions: Object

Parameters to customize the peers manager.

Type declaration

Name	Type	Description
autoAddToSelf	boolean	-
countSelf	boolean	Whether or not should the client themselves be counted as "updated". In other words, whether or not should the update function be called on the client's own data. Defaults to false.
updateChildren	boolean	Whether or not should the peers manager automatically call update on any children mesh. Defaults to true.

---

PerspectiveOptions

Ƭ PerspectiveOptions: Object

Parameters to create a new Perspective instance.

Type declaration

Name	Type	Description
blockMargin	number	The margin between the camera and any block that the camera is colliding with. This prevents the camera from clipping into blocks. Defaults to 0.3.
ignoreFluids	boolean	Whether or not should the camera ignore fluid block collisions. Defaults to true.
ignoreSeeThrough	boolean	Whether or not should the camera ignore see-through block collisions. Defaults to true.
lerpFactor	number	The lerping factor for the camera's position. Defaults to 0.5.
maxDistance	number	The maximum distance the camera can go from the player's center. Defaults to 5.

---

PortraitOptions

Ƭ PortraitOptions: Object

Parameters to create a portrait with.

Type declaration

Name	Type	Description
height	number	The height of the portrait canvas. Defaults to 100 pixels.
lightRotationOffset	number	The rotation around the y axis about the camera. This is used to calculate the position of the light. Defaults to -Math.PI / 8.
perspective	CameraPerspective	The position of where the camera should be looking at. Defaults to pxyz, which means that the camera will be looking at the center of the object from the positive x, y, and z axis scaled by the zoom.
renderOnce	boolean	Whether or not should this portrait only render once. Defaults to false.
width	number	The width of the portrait canvas. Defaults to 100 pixels.
zoom	number	The arbitrary zoom from the camera to the object. This is used to calculate the zoom of the camera. Defaults to 1.

---

ProcessedUpdate

Ƭ ProcessedUpdate: Object

Type declaration

Name	Type
newBlock	Block
newId	number
newRotation	BlockRotation
oldBlock	Block
oldId	number
oldRotation	BlockRotation
stage	number
voxel	Coords3

---

ProtocolWS

Ƭ ProtocolWS: WebSocket & { sendEvent: (event: any) => void }

A custom WebSocket type that supports protocol buffer sending.

---

RigidControlState

Ƭ RigidControlState: Object

The state of which a Voxelize Controls is in.

Type declaration

Name	Type	Description
crouching	boolean	Whether if the client is attempting to crouch, if the crouch key is pressed. Defaults to false.
currentJumpTime	number	The current amount of time spent in the air from jump. Defaults to 0.
heading	number	In radians, the heading y-rotation of the client. Defaults to 0.
isJumping	boolean	Whether or not is the client jumping, in the air. Defaults to false.
jumpCount	number	How many times has the client jumped. Defaults to 0.
jumping	boolean	Whether if the client is attempting to jump, if the jump key is pressed. Defaults to false.
running	boolean	Whether if the client is running. Defaults to false.
sprinting	boolean	Whether if the client is attempting to sprint, if the sprint key is pressed. Defaults to false.

---

RigidControlsOptions

Ƭ RigidControlsOptions: Object

Parameters to initialize the Voxelize Controls.

Type declaration

Name	Type	Description
airJumps	number	How many times can a client jump in the air. Defaults to 0.
airMoveMult	number	The factor applied to the movements of the client in air, such as while half-jump. Defaults to 0.7.
alwaysSprint	boolean	Sprint factor would be on always. Defaults to false.
bodyDepth	number	The depth of the client's avatar. Defaults to 0.8 blocks.
bodyHeight	number	The height of the client's avatar. Defaults to 1.55 blocks.
bodyWidth	number	The width of the client's avatar. Defaults to 0.8 blocks.
crouchFactor	number	The factor to the movement speed when crouch is applied. Defaults to 0.6.
eyeHeight	number	The ratio to bodyHeight at which the camera is placed from the ground. Defaults at 0.9193548387096774.
fluidPushForce	number	The force upwards when a client tries to jump in water. Defaults to 0.3.
flyForce	number	The level of force at which a client flies at. Defaults to 80.
flyImpulse	number	The level impulse of which a client flies at. Defaults to 2.5.
flyInertia	number	The inertia of a client when they're flying. Defaults to 6.
flySpeed	number	The level of speed at which a client flies at. Defaults to 40.
initialDirection	Coords3	-
initialPosition	Coords3	Initial position of the client. Defaults to (0, 80, 10).
jumpForce	number	The level of force applied to the client when jumping. Defaults to 1.
jumpImpulse	number	The level of impulse at which the client jumps upwards. Defaults to 8.
jumpTime	number	The time, in milliseconds, that a client can be jumping. Defaults to 50ms.
maxPolarAngle	number	Maximum polar angle that camera can look up to. Defaults to Math.PI * 0.99
maxSpeed	number	The maximum level of speed of a client. Default is 6 .
minPolarAngle	number	Minimum polar angle that camera can look down to. Defaults to Math.PI * 0.01.
moveForce	number	The level of force of which the client can move at. Default is 30.
positionLerp	number	The interpolation factor of the client's position. Defaults to 1.0.
responsiveness	number	The level of responsiveness of a client to movements. Default is 240.
rotationLerp	number	The interpolation factor of the client's rotation. Defaults to 0.9.
runningFriction	number	Default running friction of a client. Defaults to 0.1.
sensitivity	number	The mouse sensitivity. Defaults to 100.
sprintFactor	number	The factor to the movement speed when sprint is applied. Defaults to 1.4.
standingFriction	number	Default standing friction of a client. Defaults to 4.
stepHeight	number	How tall a client can step up. Defaults to 0.5.
stepLerp	number	The interpolation factor when the client is auto-stepping. Defaults to 0.6.

---

ShadowOptions

Ƭ ShadowOptions: Object

Parameters to create a shadow.

Type declaration

Name	Type	Description
maxDistance	number	The maximum distance from the object to the ground to cast a shadow. The shadow's scale scales inversely with distance. Defaults to 10.
maxRadius	number	The maximum radius the shadow can have. That is, the radius of the shadow when the object is on the ground. Defaults to 0.5.

---

SharedWorkerPoolJob

Ƭ SharedWorkerPoolJob: Object

A worker pool job is queued to a worker pool and is executed by a worker.

Type declaration

Name	Type	Description
buffers?	ArrayBufferLike[]	Any array buffers (transferable) that are passed to the worker.
message	any	A JSON serializable object that is passed to the worker.
resolve	(value: any) => void	-

---

SharedWorkerPoolOptions

Ƭ SharedWorkerPoolOptions: Object

Parameters to create a worker pool.

Type declaration

Name	Type	Description
maxWorker	number	The maximum number of workers to create. Defaults to 8.

---

SkyOptions

Ƭ SkyOptions: Object

Type declaration

Name	Type	Description
dimension	number	The dimension of the dodecahedron sky. The inner canvas box is 0.8 times this dimension.
lerpFactor	number	The lerp factor for the sky gradient. The sky gradient is updated every frame by lerping the current color to the target color. set by the setTopColor, setMiddleColor, and setBottomColor methods.
transitionSpan	number	-

---

SkyShadingCycleData

Ƭ SkyShadingCycleData: Object

Type declaration

Name	Type
color	{ bottom: Color | string ; middle: Color | string ; top: Color | string }
color.bottom	Color | string
color.middle	Color | string
color.top	Color | string
name	string
skyOffset	number
start	number
voidOffset	number

---

TargetType

Ƭ TargetType: "All" | "Player" | "Entity"

---

UV

Ƭ UV: Object

The UV range of a texture on the texture atlas.

Type declaration

Name	Type	Description
endU	number	The ending U coordinate of the texture.
endV	number	The ending V coordinate of the texture.
startU	number	The starting U coordinate of the texture.
startV	number	The starting V coordinate of the texture.

---

VoxelDelta

Ƭ VoxelDelta: Object

Type declaration

Name	Type
coords	Coords3
newRotation?	BlockRotation
newStage?	number
newVoxel	number
oldRotation?	BlockRotation
oldStage?	number
oldVoxel	number
sequenceId	number
timestamp	number

---

VoxelInteractOptions

Ƭ VoxelInteractOptions: Object

Parameters to customize the VoxelInteract instance.

Type declaration

Name	Type	Description
highlightColor	Color	The color of the highlight. Defaults to 0xffffff.
highlightLerp	number	The lerping factor of the highlight. Defaults to 0.8.
highlightOpacity	number	The opacity of the highlight. Defaults to 0.8.
highlightScale	number	The scale of the block highlight. Defaults to 1.002.
highlightType	"box" | "outline"	The type of the block highlight. Box would be a semi-transparent box, while outline would be 12 lines that outline the block's AABB union. Defaults to "box".
ignoreFluids	boolean	Whether or not should the VoxelInteract instance ignore fluids when raycasting. Defaults to true.
inverseDirection	boolean	Whether or not should the VoxelInteract instance reverse the raycasting direction. Defaults to false.
potentialVisuals	boolean	Debug Whether or not should there be arrows indicating the potential block placement's orientations. Defaults to false.
reachDistance	number	The maximum distance of reach for the VoxelInteract instance. Defaults to 32.

---

WorkerPoolJob

Ƭ WorkerPoolJob: Object

A worker pool job is queued to a worker pool and is executed by a worker.

Type declaration

Name	Type	Description
buffers?	ArrayBufferLike[]	Any array buffers (transferable) that are passed to the worker.
message	any	A JSON serializable object that is passed to the worker.
resolve	(value: any) => void	-

---

WorkerPoolOptions

Ƭ WorkerPoolOptions: Object

Parameters to create a worker pool.

Type declaration

Name	Type	Description
maxWorker	number	The maximum number of workers to create. Defaults to 8.

---

WorldChunkEvents

Ƭ WorldChunkEvents: Object

Type declaration

Name	Type
chunk-data-loaded	(data: ChunkDataEventData) => void
chunk-loaded	(data: ChunkEventData) => void
chunk-mesh-loaded	(data: ChunkMeshEventData) => void
chunk-mesh-unloaded	(data: ChunkMeshEventData) => void
chunk-mesh-updated	(data: ChunkMeshUpdateEventData) => void
chunk-unloaded	(data: ChunkEventData) => void
chunk-updated	(data: ChunkUpdateEventData) => void

---

WorldClientOptions

Ƭ WorldClientOptions: Object

The client-side options to create a world. These are client-side only and can be customized to specific use.

Type declaration

Name	Type	Description
chunkLoadExponent	number	The exponent applied to the ratio that chunks are loaded, which would then be used to determine whether an angle to a chunk is worth loading. Defaults to 8.
chunkRerequestInterval	number	The interval between each time a chunk is re-requested to the server. Defaults to 300 updates.
chunkUniformsOverwrite	Partial<Chunks["uniforms"]>	The uniforms to overwrite the default chunk material uniforms. Defaults to {}.
cloudsOptions	Partial<CloudsOptions>	The options to create the clouds. Defaults to {}.
defaultRenderRadius	number	The default render radius of the world, in chunks. Change this through world.renderRadius. Defaults to 8 chunks.
deltaRetentionTime	number	How long to retain delta history in milliseconds. Defaults to 5000ms.
lightJobRetryLimit	number	Maximum number of retries for stale light jobs before falling back to sync. Defaults to 3.
maxChunkRequestsPerUpdate	number	The maximum chunk requests this world can request from the server per world update. Defaults to 12 chunks.
maxLightWorkers	number	Maximum concurrent light workers. Defaults to 2.
maxLightsUpdateTime	number	-
maxMeshesPerUpdate	number	-
maxProcessesPerUpdate	number	The maximum amount of chunks received from the server that can be processed per world update. By process, it means to be turned into a Chunk instance. Defaults to 8 chunks.
maxUpdatesPerUpdate	number	The maximum voxel updates that can be sent to the server per world update. Defaults to 1000 updates.
minLightLevel	number	The minimum light level even when sunlight and torch light levels are at zero. Defaults to 0.04.
shouldGenerateChunkMeshes	boolean	Whether or not should the world generate ThreeJS meshes. Defaults to true.
skyOptions	Partial<SkyOptions>	The options to create the sky. Defaults to {}.
statsSyncInterval	number	The interval between each time the world requests the server for its stats. Defaults to 500ms.
sunlightChangeSpan	number	The fraction of the day that sunlight takes to change from appearing to disappearing or disappearing to appearing. Defaults to 0.1.
sunlightEndTimeFrac	number	The fraction of the day that sunlight starts to disappear. Defaults to 0.7.
sunlightStartTimeFrac	number	The fraction of the day that sunlight starts to appear. Defaults to 0.25.
textureUnitDimension	number	The default dimension to a single unit of a block face texture. If any texture loaded is greater, it will be downscaled to this resolution. Defaults to 8 pixels.
timeForceThreshold	number	The threshold to force the server's time to the client's time. Defaults to 0.1.
useLightWorkers	boolean	Whether to use web workers for light calculations. Defaults to true.

---

WorldOptions

Ƭ WorldOptions: WorldClientOptions & WorldServerOptions

The options to create a world. This consists of WorldClientOptions and WorldServerOptions.

---

WorldServerOptions

Ƭ WorldServerOptions: Object

The options defined on the server-side, passed to the client on network joining.

Type declaration

Name	Type	Description
airDrag	number	The air drag of everything physical.
chunkSize	number	The width and depth of a chunk, in blocks.
doesTickTime	boolean	-
fluidDensity	number	The density of the fluid in this world.
fluidDrag	number	The fluid drag of everything physical.
gravity	number[]	The gravity of everything physical in this world.
maxChunk	[number, number]	The maximum chunk coordinate of this world, inclusive.
maxHeight	number	The height of a chunk, in blocks.
maxLightLevel	number	The maximum light level that propagates in this world, including sunlight and torch light.
minBounceImpulse	number	The minimum bouncing impulse of everything physical in this world.
minChunk	[number, number]	The minimum chunk coordinate of this world, inclusive.
subChunks	number	The number of sub-chunks that divides a chunk vertically.
timePerDay	number	The time per day in seconds.

Variables

BLUE_LIGHT

• Const BLUE_LIGHT: "BLUE"

The string representation of blue light.

---

BOX_SIDES

• Const BOX_SIDES: BoxSides[]

The six default faces of a canvas box.

---

DEFAULT_CHUNK_SHADERS

• Const DEFAULT_CHUNK_SHADERS: Object

This is the default shaders used for the chunks.

Type declaration

Name	Type
fragment	string
vertex	string

---

GREEN_LIGHT

• Const GREEN_LIGHT: "GREEN"

The string representation of green light.

---

NX_ROTATION

• Const NX_ROTATION: 3

The numerical representation of the negative X rotation.

---

NY_ROTATION

• Const NY_ROTATION: 1

The numerical representation of the negative Y rotation.

---

NZ_ROTATION

• Const NZ_ROTATION: 5

The numerical representation of the negative Z rotation.

---

OPAQUE_RENDER_ORDER

• Const OPAQUE_RENDER_ORDER: 100

---

PX_ROTATION

• Const PX_ROTATION: 2

The numerical representation of the positive X rotation.

---

PY_ROTATION

• Const PY_ROTATION: 0

The numerical representation of the positive Y rotation.

---

PZ_ROTATION

• Const PZ_ROTATION: 4

The numerical representation of the positive Z rotation.

---

RED_LIGHT

• Const RED_LIGHT: "RED"

The string representation of red light.

---

SUNLIGHT

• Const SUNLIGHT: "SUNLIGHT"

The string representation of sunlight.

---

TRANSPARENT_RENDER_ORDER

• Const TRANSPARENT_RENDER_ORDER: 100000

---

Y_ROT_MAP

• Const Y_ROT_MAP: [number, number][] = []

A rotational map used to get the closest y-rotation representation to a y-rotation value.

Rotation value -> index

---

Y_ROT_MAP_EIGHT

• Const Y_ROT_MAP_EIGHT: [number, number][] = []

---

Y_ROT_MAP_FOUR

• Const Y_ROT_MAP_FOUR: [number, number][] = []

---

Y_ROT_SEGMENTS

• Const Y_ROT_SEGMENTS: 16

The amount of Y-rotation segments should be allowed for y-rotatable blocks. In other words, the amount of times the block can be rotated around the y-axis within 360 degrees.

The accepted Y-rotation values will be from 0 to Y_ROTATION_SEGMENTS - 1.

---

artFunctions

• Const artFunctions: Object

A preset of art functions to draw on canvas boxes.

Type declaration

Name	Type
drawCrown	ArtFunction
drawMoon	(moonRadius: number, moonColor: string, phase: number) => (context: CanvasRenderingContext2D, canvas: HTMLCanvasElement) => void
drawStars	(starCount: number, starColors: string[]) => (context: CanvasRenderingContext2D, canvas: HTMLCanvasElement) => void
drawSun	(sunRadius: number, sunColor: string) => (context: CanvasRenderingContext2D, canvas: HTMLCanvasElement) => void

---

customShaders

• Const customShaders: Object

Type declaration

Name	Type
sway	(options: Partial<{ amplitude: number ; rooted: boolean ; scale: number ; speed: number ; yScale: number }>) => { fragmentShader: string = DEFAULT_CHUNK_SHADERS.fragment; vertexShader: string }

---

defaultArmsOptions

• Const defaultArmsOptions: ArmsOptions

---

defaultBodyOptions

• Const defaultBodyOptions: BodyOptions

---

defaultCharacterOptions

• Const defaultCharacterOptions: CharacterOptions

---

defaultHeadOptions

• Const defaultHeadOptions: HeadOptions

---

defaultLegsOptions

• Const defaultLegsOptions: LegOptions

Functions

TRANSPARENT_SORT

▸ TRANSPARENT_SORT(object): (a: any, b: any) => number

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

fn

▸ (a, b): number

Parameters

Name	Type
a	any
b	any

Returns

number

---

cull

▸ cull(array, options): Promise<MeshResultType>

Parameters

Name	Type
array	NdArray<number[] | TypedArray | GenericArray<number>>
options	CullOptionsType

Returns

Promise<MeshResultType>

---

requestWorkerAnimationFrame

▸ requestWorkerAnimationFrame(callback): number

Parameters

Name	Type
callback	() => void

Returns

number

---

setWorkerInterval

▸ setWorkerInterval(func, interval): () => void

Parameters

Name	Type
func	() => void
interval	number

Returns

fn

▸ (): void

Returns

void