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.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
API surface — esengine/foliage
Symbols: 0 public · 0 beta · 44 experimental · 0 deprecated
BladeParams — interface @experimental
band: number | undefined
height: number
lean: number | undefined
paint: { base: [number, number, number]; tip: [number, number, number]; } | null | undefined
segments: number
thin: number
width: number
CardRect — interface @experimental
u0: number
u1: number
v0: number
v1: number
Foliage — const @experimental
ComponentDef<FoliageData>
FoliageContact — const @experimental
ComponentDef<FoliageContactData>
FoliageContactData — interface @experimental
enabled: boolean
radius: number
recovery: number
strength: number
FoliageData — interface @experimental
bladeHeight: number
bladeLean: number
bladeWidth: number
cardTent: number
cardU0: number
cardU1: number
cardV0: number
cardV1: number
castShadows: boolean
cellSize: number
colorMap: number
colorMapFrom: number
colorMapStrength: number
count: number
densityMap: number
drawDistance: number
faceEye: number
faceEyeNear: number
farCards: boolean
farGrow: number
farGrowUp: number
farKeep: number
farLevels: number
farStep: number
farTilt: number
heightMax: number
heightMin: number
lodDistance: number
material: number
maxScale: number
mesh: number
minScale: number
minUp: number
palette: number
scaleMap: number
seed: number
sizeX: number
sizeZ: number
waterDepth: number
zonePadding: number
zoneTags: string
zoneWorld: string
FoliageField — class @experimental
@internal app_: App | null
@internal authoredWind_: Map<number, number>
@internal built_: Map<number, BuiltFoliage>
@internal landed_: (() => void)[]
cellCount: number
pending: number
retired_: { instance: number; frames: number; }[]
static new (): FoliageField
static prototype: FoliageField
FoliagePlugin — class @experimental
activeWhen: ComponentDef<FoliageData>[]
build: (app: App) => void
cleanup: (app?: App) => void
name: string
static new (): FoliagePlugin
static prototype: FoliagePlugin
FoliageRes — const @experimental
ResourceDef<FoliageField>
Ground — type @experimental
(x: number, z: number) => { y: number; up: number } | null
PLACED_STRIDE — const @experimental
6
PlacedFoliage — const @experimental
ComponentDef<PlacedFoliageData>
PlacedFoliageData — interface @experimental
cellSize: number
kinds: PlacedKind[]
records: number[]
sizeX: number
sizeZ: number
stateKey: string
PlacedFoliageField — class @experimental
@internal app_: App | null
@internal built_: Map<number, BuiltPlaced>
cellCount: number
pending: number
static new (): PlacedFoliageField
static prototype: PlacedFoliageField
PlacedFoliagePlugin — class @experimental
build: (app: App) => void
cleanup: (app?: App) => void
name: string
static new (): PlacedFoliagePlugin
static prototype: PlacedFoliagePlugin
PlacedFoliageRes — const @experimental
ResourceDef<PlacedFoliageField>
PlacedKind — interface @experimental
drawDistance: number
far: PlacedPart[]
farDistance: number
farKeep: number | undefined
interaction: PlantInteractionDef | undefined
lod2Distance: number | undefined
lodDistance: number
parts: PlacedPart[]
PlacedPart — interface @experimental
castShadows: boolean | undefined
lod1Mesh: string
lod2Mesh: string | undefined
material: string
mesh: string
opaque: boolean
soft: number | undefined
texture: string
tint: [number, number, number, number]
Plant — interface @experimental
key: string | undefined
phase: number
scale: number
shade: number
shear: readonly [number, number] | undefined
spread: number | undefined
tilt: number | undefined
up: readonly [number, number, number] | undefined
x: number
y: number
yaw: number
z: number
PlantEvent — interface @experimental
plant: PlantRef
type: "activated" | "damaged" | "deactivated" | "felled" | "harvested" | "landed" | "regrown" | "removed"
PlantGrowth — class @experimental
@internal observer_: PlacementObserver | null
@internal placeTurned: (app: App, cell: GrownCell, kinds: readonly PlacedKind[], ready: ReadyKinds, kindIndex: number) => void
@internal writeSet: (app: App, cell: GrownCell, set: PlacementSet) => void
app_: App | null
growCell: (app: App, cell: GrownCell, kinds: readonly PlacedKind[], ready: ReadyKinds, byKind: ReadonlyMap<number, readonly Plant[]>) => void
growFar: (app: App, cell: GrownCell, kinds: readonly PlacedKind[], ready: ReadyKinds, byKind: ReadonlyMap<number, readonly Plant[]>, _at?: { x: number; z: number; half?: number; }, thinnedBy?: number) => void
made: number
pending: number
queue: { cell: GrownCell; run: () => void; }[]
release: (app: App, cell: GrownCell) => void
spentMs: number
step: (app: App) => void
static new (): PlantGrowth
static prototype: PlantGrowth
PlantGrowthRes — const @experimental
ResourceDef<PlantGrowth>
PlantInteraction — class @experimental
@internal addCell: (grown: GrownCell, source: string, kinds: readonly PlacedKind[], ready: ReadyKinds, byKind: ReadonlyMap<number, readonly Plant[]>, half: number) => void
@internal addFarCell: (grown: GrownCell, source: string, kinds: readonly PlacedKind[], ready: ReadyKinds) => void
@internal app_: App | null
@internal placementsOf: (grown: GrownCell, set: PlacementSet) => readonly Plant[]
@internal removeCell: (grown: GrownCell) => void
@internal step: (dt: number) => void
activeCount: number
changedCount: number
damage: (plant: PlantRef, amount: number, from?: { x: number; z: number; }) => boolean
fell: (plant: PlantRef, toward?: { x: number; z: number; }) => boolean
find: (source: string, key: string) => PlantRef | null
harvest: (plant: PlantRef, amount?: number) => number
loadState: (state: PlantSaveState) => void
maxActivatedPerFrame: number
maxActive: number
near: (x: number, z: number, radius: number) => PlantRef[]
of: (entity: Entity) => PlantRef | null
on: (listener: (event: PlantEvent) => void) => () => void
remove: (plant: PlantRef) => boolean
saveState: () => PlantSaveState
static new (): PlantInteraction
static prototype: PlantInteraction
PlantInteractionDef — interface @experimental
activationDistance: number | undefined
bend: number | undefined
fallAngle: number | undefined
fallSeconds: number | undefined
felledKind: string | number | undefined
harvestedKind: string | number | undefined
health: number | undefined
height: number | undefined
lieSeconds: number | undefined
radius: number | undefined
regrowSeconds: number | undefined
yields: number | undefined
PlantInteractionRes — const @experimental
ResourceDef<PlantInteraction>
PlantKind — interface @experimental
drawDistance: number
far: PlacedPart[]
farDistance: number
farKeep: number | undefined
interaction: PlantInteractionDef | undefined
lod2Distance: number | undefined
lodDistance: number
parts: PlacedPart[]
sink: number | undefined
tintScale: number | undefined
tints: [number, number, number][] | undefined
unit: number | undefined
PlantProxy — const @experimental
ComponentDef<PlantProxyData>
PlantProxyData — interface @experimental
key: string
source: string
PlantRef — interface @experimental
entity: number | null
health: number
key: string
kind: number
scale: number
source: string
state: PlantState
x: number
y: number
yields: number
z: number
PlantSaveState — interface @experimental
clock: number
plants: { source: string; key: string; state: PlantState; shownAs: number; health: number; yields: number; regrowAt: number; }[]
version: 1
PlantState — type @experimental
'standing' | 'felled' | 'harvested' | 'removed'
ScatterParams — interface @experimental
cellKey: number
centerX: number
centerZ: number
count: number
heightMax: number
heightMin: number
maxScale: number
minScale: number
minUp: number
seed: number
size: number
buildBillboardMesh — function @experimental
(plants: readonly Plant[], width: number, height: number, rect: CardRect, paint?: BladeParams["paint"], triangle?: boolean): MeshData
buildGrassMesh — function @experimental
(plants: readonly Plant[], blade: BladeParams): MeshData
buildInstancedMesh — function @experimental
(source: MeshData, plants: readonly Plant[], paint?: BladeParams["paint"], band?: number, seats?: boolean): MeshData
buildPlacedMesh — function @experimental
(source: MeshData, plants: readonly Plant[]): MeshData
foliagePlugin — const @experimental
Plugin
placedFoliagePlugin — const @experimental
Plugin
plantGrowthOf — function @experimental
(app: App): PlantGrowth
plantInteractionOf — function @experimental
(app: App): PlantInteraction
rng — function @experimental
(seed: number): () => number
scatterCell — function @experimental
(p: ScatterParams, ground: Ground): Plant[]
softenNormals — function @experimental
(source: MeshData, amount: number): MeshData
thinPlants — function @experimental
(plants: readonly Plant[], keep: number, already?: number): readonly Plant[]