Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

5.8 KB
Raw Blame

API surface — esengine/voxel

Symbols: 0 public · 0 beta · 26 experimental · 0 deprecated

VOXEL_MATERIALS — const @experimental

4

VoxelEditEvent — interface @experimental

entity: number
op: VoxelOp
result: VoxelEditResult
shape: VoxelShape

VoxelEditOptions — interface @experimental

keep: ((material: number) => boolean) | undefined
material: number | undefined
smooth: number | undefined

VoxelEditResult — interface @experimental

added: number
chunks: number
removed: number[]

VoxelField — class @experimental

apply: (shape: VoxelShape, op: VoxelOp, options?: VoxelEditOptions) => VoxelEditResult
cellSize: number
chunk: (cx: number, cy: number, cz: number) => VoxelChunk
chunkCells: number
distanceAt: (x: number, y: number, z: number) => number
held: { chunks: number; edited: number; }
materialAt: (x: number, y: number, z: number) => number
raycast: (origin: VoxelPoint, direction: VoxelPoint, maxDistance: number) => VoxelHit | null
restore: (data: VoxelFieldData, merge?: boolean, skipped?: string[]) => boolean
rowMax: number
rowMin: number
serialize: (changedOnly?: boolean) => VoxelFieldData
side: number
takeDirty: () => VoxelChunk[]
trim: (keep?: (chunk: VoxelChunk) => boolean) => void
static new (options: VoxelFieldOptions): VoxelField
static prototype: VoxelField

VoxelFieldData — interface @experimental

cellSize: number
chunkCells: number
chunks: Record<string, string>
version: 1

VoxelFieldOptions — interface @experimental

cached: number | undefined
cellSize: number
chunkCells: number
maxY: number
minY: number
source: VoxelSource

VoxelHit — interface @experimental

distance: number
material: number
normal: VoxelPoint
point: VoxelPoint

VoxelMaterial — const @experimental

{ readonly Topsoil: 0; readonly Soil: 1; readonly Rock: 2; readonly Ore: 3; }

VoxelNoiseParams — interface @experimental

caveScale: number
caveWidth: number
cellSize: number | undefined
hillHeight: number
hillScale: number
oreAmount: number
seed: number
soilDepth: number
surfaceHeight: number

VoxelOp — type @experimental

'subtract' | 'add' | 'paint'

VoxelPlugin — class @experimental

activeWhen: ComponentDef<VoxelTerrainData>[]
build: (app: App) => void
cleanup: (app?: App) => void
name: string
static new (): VoxelPlugin
static prototype: VoxelPlugin

VoxelPoint — interface @experimental

x: number
y: number
z: number

VoxelSample — interface @experimental

distance: number
material: number

VoxelShape — type @experimental

| { kind: 'sphere'; center: VoxelPoint; radius: number }
    | { kind: 'box'; center: VoxelPoint; halfExtents: VoxelPoint }
    | { kind: 'capsule'; from: VoxelPoint; to: VoxelPoint; radius: number }

VoxelSource — type @experimental

(x: number, y: number, z: number, out: VoxelSample) => void

VoxelSurface — interface @experimental

indices: Uint32Array<ArrayBufferLike>
normals: Float32Array<ArrayBufferLike>
positions: Float32Array<ArrayBufferLike>
weights: Uint8Array<ArrayBufferLike>

VoxelTerrain — const @experimental

ComponentDef<VoxelTerrainData>

VoxelTerrainData — interface @experimental

castShadows: boolean
caveScale: number
caveWidth: number
cellSize: number
chunkCells: number
collision: boolean
collisionDistance: number
collisionLayer: number
color0: Color
color1: Color
color2: Color
color3: Color
drawDistance: number
friction: number
hillHeight: number
hillScale: number
map0: number
map1: number
map2: number
map3: number
material: number
maxY: number
minY: number
oreAmount: number
seed: number
soilDepth: number
surfaceHeight: number
tile: number

VoxelTerrainStatus — interface @experimental

collidingChunks: number
drawnChunks: number
editedChunks: number
heldChunks: number
lastRebuildMs: number
triangles: number
waitingChunks: number

VoxelTerrains — class @experimental

@internal app_: App | null
@internal built_: Map<number, Built>
@internal ensure_: ((entity: Entity) => Built | null) | null
@internal sourceIds_: Map<VoxelSource, number>
@internal sources_: Map<number, VoxelSource>
carve: (entity: Entity, shape: VoxelShape, options?: VoxelEditOptions) => VoxelEditResult | null
collisionReadyAt: (entity: Entity, x: number, z: number) => boolean
distanceAt: (entity: Entity, at: VoxelPoint) => number | null
edit: (entity: Entity, shape: VoxelShape, op: VoxelOp, options?: VoxelEditOptions) => VoxelEditResult | null
fill: (entity: Entity, shape: VoxelShape, material?: number, options?: VoxelEditOptions) => VoxelEditResult | null
materialAt: (entity: Entity, at: VoxelPoint) => number | null
onEdit: (listener: (event: VoxelEditEvent) => void) => () => void
raycast: (origin: VoxelPoint, direction: VoxelPoint, maxDistance?: number) => (VoxelHit & { entity: Entity; }) | null
restore: (entity: Entity, data: VoxelFieldData, merge?: boolean) => boolean
serialize: (entity: Entity, changedOnly?: boolean) => VoxelFieldData | null
setSource: (entity: Entity, source: VoxelSource | null) => void
status: (entity: Entity) => VoxelTerrainStatus | null
static new (): VoxelTerrains
static prototype: VoxelTerrains

VoxelTerrainsRes — const @experimental

ResourceDef<VoxelTerrains>

heightVoxelSource — function @experimental

(heightAt: (x: number, z: number) => number | null, material?: (depth: number, sample: VoxelSample) => void): VoxelSource

noiseVoxelSource — function @experimental

(params: VoxelNoiseParams): VoxelSource

surfaceNets — function @experimental

(distances: Int8Array, materials: Uint8Array, cells: number, cellSize: number): VoxelSurface | null

voxelPlugin — const @experimental

VoxelPlugin