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.

feat(sdk): terrain and foliage are optional modules, so a package carries them only when its content does

yhhb078de950c5c
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d718b7456..39a2854df 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,10 @@ published separately; it ships inside the editor.
## [Unreleased]
+### Changed
+
+- **Terrain and Foliage are optional modules.** Terrain and Foliage are now optional modules, esengine/terrain and esengine/foliage: a package carries them when a scene has a Terrain or Foliage component or a script imports the subpath, and a game with neither ships none of them (about 33 KB less in a UI-only mini-game). Import `Terrain`, `Foliage` and their helpers from `esengine/terrain` and `esengine/foliage` rather than `esengine`; the export installs the module for a scene that uses either component.
+
## [0.94.0] - 2026-10-22
### Added
diff --git a/docs/astro/src/content/docs/graphics/foliage.mdx b/docs/astro/src/content/docs/graphics/foliage.mdx
index f513dfaae..7310e31a3 100644
--- a/docs/astro/src/content/docs/graphics/foliage.mdx
+++ b/docs/astro/src/content/docs/graphics/foliage.mdx
@@ -43,6 +43,10 @@ Each cell is built twice. Near, grass is a bent, tapered blade for every plant;
copied in full near, and far is two crossed cards a plant. The engine's own [level of detail](/docs/performance/level-of-detail/) picks between
them by how much of the screen the cell covers, and drops the cell past `drawDistance`.
+## In a package
+
+Foliage is an optional module, like terrain: a package carries it when a scene has a `Foliage` component or a script imports `esengine/foliage`. It stands on a `Terrain` when the scene has one and needs no terrain module to stand on a flat floor.
+
## Limits
- **Position only.** The area is taken to be unrotated and unscaled; the terrain's position and uniform scale are followed, a rotation is not.
diff --git a/docs/astro/src/content/docs/graphics/terrain.mdx b/docs/astro/src/content/docs/graphics/terrain.mdx
index 991a589c6..14ec14cab 100644
--- a/docs/astro/src/content/docs/graphics/terrain.mdx
+++ b/docs/astro/src/content/docs/graphics/terrain.mdx
@@ -43,10 +43,12 @@ at every level, so a chunk keeps its lighting as it coarsens and only its silhou
## From code
+Terrain is an optional module: a package carries it when a scene has a `Terrain`, or when a script imports `esengine/terrain` (as below). A game with neither ships none of it.
+
The ground can be asked how high it is, for putting things on it:
```ts
-import { TerrainsRes } from 'esengine';
+import { TerrainsRes } from 'esengine/terrain';
const terrains = app.getResource(TerrainsRes);
const y = terrains.heightAt(x, z); // world height, or null where there is no terrain
diff --git a/docs/astro/src/content/docs/zh-cn/graphics/foliage.mdx b/docs/astro/src/content/docs/zh-cn/graphics/foliage.mdx
index 5fa35cb8e..afcf5a750 100644
--- a/docs/astro/src/content/docs/zh-cn/graphics/foliage.mdx
+++ b/docs/astro/src/content/docs/zh-cn/graphics/foliage.mdx
@@ -33,6 +33,10 @@ description: 一个 Foliage 组件,把草或网格散布到一片区域或地形
每个格子构建两次。近处,草是每棵植物一根弯曲、渐细的草叶;远处,是三分之一的草叶,更宽而且更平。网格近处是完整的拷贝,远处是每棵植物两张交叉的卡片。引擎自己的[细节层级](/docs/zh-cn/performance/level-of-detail/)按格子覆盖多少屏幕在它们之间选择,超过 `drawDistance` 就把格子丢掉。
+## 在包里
+
+植被和地形一样是可选模块:场景里有 `Foliage` 组件,或脚本导入了 `esengine/foliage`,包里才会带上它。场景里有 `Terrain` 时植被立在地形上;平地上不需要地形模块。
+
## 限制
- **只有位置。** 区域被当作不旋转、不缩放;地形的位置和均匀缩放会被跟随,旋转不会。
diff --git a/docs/astro/src/content/docs/zh-cn/graphics/terrain.mdx b/docs/astro/src/content/docs/zh-cn/graphics/terrain.mdx
index 2c3dfee95..6a99bdf6c 100644
--- a/docs/astro/src/content/docs/zh-cn/graphics/terrain.mdx
+++ b/docs/astro/src/content/docs/zh-cn/graphics/terrain.mdx
@@ -32,10 +32,12 @@ description: 一个 Terrain 组件,用高度图或噪声生成地面,按高度
## 从代码里用
+地形是可选模块:场景里有 `Terrain`,或脚本导入了 `esengine/terrain`(如下),包里才会带上它;两者都没有的游戏不带任何地形代码。
+
可以问地面某处有多高,用来把东西放上去:
```ts
-import { TerrainsRes } from 'esengine';
+import { TerrainsRes } from 'esengine/terrain';
const terrains = app.getResource(TerrainsRes);
const y = terrains.heightAt(x, z); // 世界高度,没有地形的地方为 null
diff --git a/pipeline/src/bundle/engineSubpaths.ts b/pipeline/src/bundle/engineSubpaths.ts
index 65614ec8d..7a7da03ea 100644
--- a/pipeline/src/bundle/engineSubpaths.ts
+++ b/pipeline/src/bundle/engineSubpaths.ts
@@ -12,6 +12,8 @@
export const ESENGINE_SUBPATHS: Readonly<Record<string, string>> = {
'esengine/spine': 'spine/index.js',
'esengine/tilemap': 'tilemap/index.js',
+ 'esengine/terrain': 'terrain/index.js',
+ 'esengine/foliage': 'foliage/index.js',
'esengine/logic': 'logic/index.js',
'esengine/debug-channel': 'debug-channel/index.js',
'esengine/ai': 'ai/index.js',
diff --git a/pipeline/src/project/targetSupport.ts b/pipeline/src/project/targetSupport.ts
index 49fe024a7..3030d3ef9 100644
--- a/pipeline/src/project/targetSupport.ts
+++ b/pipeline/src/project/targetSupport.ts
@@ -27,7 +27,7 @@ import { NATIVE_PLATFORMS, type ExportPlatform } from './platforms';
/** An engine subsystem a build target may lack. */
export type Subsystem =
- | 'text' | 'tilemap' | 'particles' | 'postprocess' | 'physics' | 'physics3d'
+ | 'text' | 'tilemap' | 'terrain' | 'foliage' | 'particles' | 'postprocess' | 'physics' | 'physics3d'
| 'spine' | 'dragonbones' | 'video' | 'ai' | 'logic' | 'replication' | 'gameplay';
/**
@@ -39,6 +39,8 @@ export type Subsystem =
export const SUBSYSTEM_COMPONENTS: Readonly<Record<Subsystem, readonly string[]>> = {
text: ['Text', 'BitmapText'],
tilemap: ['Tilemap', 'TilemapLayer'],
+ terrain: ['Terrain'],
+ foliage: ['Foliage'],
particles: ['ParticleEmitter', 'ParticleForceField'],
postprocess: ['PostProcessVolume'],
physics: [
@@ -69,6 +71,8 @@ export const SUBSYSTEM_COMPONENTS: Readonly<Record<Subsystem, readonly string[]>
export const SUBSYSTEM_LABEL: Readonly<Record<Subsystem, string>> = {
text: 'Text',
tilemap: 'Tilemaps',
+ terrain: 'Terrain',
+ foliage: 'Foliage',
particles: 'Particles',
postprocess: 'Post-processing',
physics: 'Physics (Box2D)',
@@ -93,6 +97,8 @@ export const SUBSYSTEM_INSTALL: Readonly<Record<Subsystem, string>> = {
particles: 'base',
postprocess: 'base',
tilemap: 'esengine/tilemap',
+ terrain: 'esengine/terrain',
+ foliage: 'esengine/foliage',
physics: 'esengine/physics',
physics3d: 'esengine/physics3d',
spine: 'esengine/spine',
diff --git a/pipeline/tests/engine-installs.test.ts b/pipeline/tests/engine-installs.test.ts
index 041121d0e..408e8994a 100644
--- a/pipeline/tests/engine-installs.test.ts
+++ b/pipeline/tests/engine-installs.test.ts
@@ -19,6 +19,12 @@ describe('the engine modules a package installs', () => {
.toEqual({ lean: true, subpaths: ['esengine/ai', 'esengine/tilemap'], refused: [] });
});
+ it('takes terrain and foliage from their components, so a game with neither carries neither', () => {
+ expect(engineInstalls({ subsystems: ['terrain', 'foliage'] }).subpaths)
+ .toEqual(['esengine/foliage', 'esengine/terrain']);
+ expect(engineInstalls({ subsystems: ['particles'] }).subpaths).toEqual([]);
+ });
+
it('takes one a document names by asset rather than by component', () => {
// Nothing in a scene says "script graph"; the .esgraph it references does.
expect(engineInstalls({ assetPaths: ['assets/logic/Door.esgraph'] }).subpaths)
diff --git a/sdk/etc/foliage.api.md b/sdk/etc/foliage.api.md
new file mode 100644
index 000000000..81581ee45
--- /dev/null
+++ b/sdk/etc/foliage.api.md
@@ -0,0 +1,136 @@
+# API surface — esengine/foliage
+
+<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
+Symbols: 0 public · 0 beta · 16 experimental · 0 deprecated
+
+## BladeParams — interface @experimental
+```
+height: number
+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>
+```
+
+## FoliageData — interface @experimental
+```
+bladeHeight: number
+bladeWidth: number
+cardTent: number
+cardU0: number
+cardU1: number
+cardV0: number
+cardV1: number
+cellSize: number
+count: number
+drawDistance: number
+heightMax: number
+heightMin: number
+lodDistance: number
+material: number
+maxScale: number
+mesh: number
+minScale: number
+minUp: number
+seed: number
+sizeX: number
+sizeZ: number
+```
+
+## FoliageField — class @experimental
+```
+@internal built_: Map<number, BuiltFoliage>
+cellCount: number
+pending: number
+static new (): FoliageField
+static prototype: FoliageField
+```
+
+## FoliagePlugin — class @experimental
+```
+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
+```
+
+## Plant — interface @experimental
+```
+phase: number
+scale: number
+shade: number
+x: number
+y: number
+yaw: number
+z: number
+```
+
+## 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"]): MeshData
+```
+
+## foliagePlugin — const @experimental
+```
+Plugin
+```
+
+## rng — function @experimental
+```
+(seed: number): () => number
+```
+
+## scatterCell — function @experimental
+```
+(p: ScatterParams, ground: Ground): Plant[]
+```
+
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 1c87e0dc5..e6a951600 100644
--- a/sdk/etc/index.api.md
+++ b/sdk/etc/index.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/index
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 115 public · 159 beta · 1706 experimental · 3 deprecated
+Symbols: 115 public · 159 beta · 1671 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -1640,15 +1640,6 @@ op: CompareOp
value: string | number | boolean | undefined
```
-## BladeParams — interface @experimental
-```
-height: number
-paint: { base: [number, number, number]; tip: [number, number, number]; } | null | undefined
-segments: number
-thin: number
-width: number
-```
-
## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
@@ -2180,14 +2171,6 @@ rgb: Float32Array<ArrayBufferLike>
width: number
```
-## CardRect — interface @experimental
-```
-u0: number
-u1: number
-v0: number
-v1: number
-```
-
## Catalog — class @experimental
```
addressOf: (path: string) => string | null
@@ -4040,59 +4023,6 @@ isFocused: boolean
tabIndex: number
```
-## Foliage — const @experimental
-```
-ComponentDef<FoliageData>
-```
-
-## FoliageData — interface @experimental
-```
-bladeHeight: number
-bladeWidth: number
-cardTent: number
-cardU0: number
-cardU1: number
-cardV0: number
-cardV1: number
-cellSize: number
-count: number
-drawDistance: number
-heightMax: number
-heightMin: number
-lodDistance: number
-material: number
-maxScale: number
-mesh: number
-minScale: number
-minUp: number
-seed: number
-sizeX: number
-sizeZ: number
-```
-
-## FoliageField — class @experimental
-```
-@internal built_: Map<number, BuiltFoliage>
-cellCount: number
-pending: number
-static new (): FoliageField
-static prototype: FoliageField
-```
-
-## FoliagePlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): FoliagePlugin
-static prototype: FoliagePlugin
-```
-
-## FoliageRes — const @experimental
-```
-ResourceDef<FoliageField>
-```
-
## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
@@ -4447,11 +4377,6 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## Ground — type @experimental
-```
-(x: number, z: number) => { y: number; up: number } | null
-```
-
## HdrFormat — interface @experimental
```
effective: string
@@ -4467,13 +4392,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Heightfield — interface @experimental
-```
-data: Float32Array<ArrayBufferLike>
-height: number
-width: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -6313,17 +6231,6 @@ updated: boolean | undefined
width: number | undefined
```
-## Plant — interface @experimental
-```
-phase: number
-scale: number
-shade: number
-x: number
-y: number
-yaw: number
-z: number
-```
-
## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
@@ -6920,16 +6827,6 @@ fingerprint: string
pending: PendingSystemEntry[]
```
-## ProceduralParams — interface @experimental
-```
-frequency: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-seed: number
-```
-
## ProcessedEntity — interface @experimental
```
children: number[]
@@ -7771,21 +7668,6 @@ setJSON: <T>(key: string, value: T) => void
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## 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
-```
-
## SceneAmbientLight — interface @experimental
```
drawEnvironment: boolean
@@ -9395,81 +9277,6 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## Terrain — const @experimental
-```
-ComponentDef<TerrainData>
-```
-
-## TerrainData — interface @experimental
-```
-chunkCells: number
-chunks: number
-detail: number
-dirtHeight: number
-frequency: number
-height: number
-heightmap: number
-layerColor0: Color
-layerColor1: Color
-layerColor2: Color
-layerColor3: Color
-lodLevels: number
-material: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-rockSlope: number
-seed: number
-sizeX: number
-sizeZ: number
-snowHeight: number
-splatmap: number
-```
-
-## TerrainPaint — type @experimental
-```
-(
- u: number, v: number, height01: number, slope: number,
-) => [number, number, number, number]
-```
-
-## TerrainPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): TerrainPlugin
-static prototype: TerrainPlugin
-```
-
-## TerrainShape — interface @experimental
-```
-chunkCells: number
-chunks: number
-height: number
-sizeX: number
-sizeZ: number
-```
-
-## Terrains — class @experimental
-```
-@internal app_: App | null
-@internal built_: Map<number, Built>
-@internal revision_: number
-heightAt: (x: number, z: number) => number | null
-loading: boolean
-normalAt: (x: number, z: number) => [number, number, number] | null
-pending: number
-static new (): Terrains
-static prototype: Terrains
-```
-
-## TerrainsRes — const @experimental
-```
-ResourceDef<Terrains>
-```
-
## Text — const @public
```
ComponentDef<TextData>
@@ -11810,31 +11617,11 @@ MotionDriver<AnimatorBlend2DMotion>
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildBillboardMesh — function @experimental
-```
-(plants: readonly Plant[], width: number, height: number, rect: CardRect, paint?: BladeParams["paint"], triangle?: boolean): MeshData
-```
-
-## buildChunkMesh — function @experimental
-```
-(field: Heightfield, shape: TerrainShape, cx: number, cz: number, lod: number, paint: TerrainPaint): MeshData
-```
-
## buildFrameProfile — function @experimental
```
(input: FrameProfileInput): FrameProfile
```
-## buildGrassMesh — function @experimental
-```
-(plants: readonly Plant[], blade: BladeParams): MeshData
-```
-
-## buildInstancedMesh — function @experimental
-```
-(source: MeshData, plants: readonly Plant[], paint?: BladeParams["paint"]): MeshData
-```
-
## buildText — function @experimental
```
(init?: TextInit): TextData
@@ -11945,21 +11732,11 @@ MotionDriver<AnimatorBlend2DMotion>
(cellX: number, cellZ: number, cellSize: number): { minX: number; minZ: number; maxX: number; maxZ: number; }
```
-## cellsAtLod — function @experimental
-```
-(shape: TerrainShape, lod: number): number
-```
-
## censusProbeIds — function @experimental
```
(): string[]
```
-## chunkCenter — function @experimental
-```
-(shape: TerrainShape, cx: number, cz: number): [number, number]
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -12740,11 +12517,6 @@ FocusPlugin
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## foliagePlugin — const @experimental
-```
-Plugin
-```
-
## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
@@ -12985,11 +12757,6 @@ Plugin
() => Plugin[]
```
-## heightfieldFromPixels — function @experimental
-```
-(width: number, height: number, pixels: ArrayLike<number>): Heightfield
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -13290,11 +13057,6 @@ LifecyclePlugin
LocalizationPlugin
```
-## lodCount — function @experimental
-```
-(shape: TerrainShape, wanted?: number): number
-```
-
## log — const @experimental
```
Logger
@@ -13460,11 +13222,6 @@ MeshRendererPlugin
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit" | "aot" | "debugChannel">): { physicsEnabled?: boolean; physicsConfig?: Physics2DPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; aot?: PackagedGameConfig["aot"]; debugChannel?: DebugChannelConfig; }
```
-## paintWeights — function @experimental
-```
-(h: number, ny: number, t: Pick<TerrainData, "rockSlope" | "dirtHeight" | "snowHeight">): [number, number, number, number]
-```
-
## panoramaDirection — function @experimental
```
(u: number, v: number): [number, number, number]
@@ -13755,11 +13512,6 @@ PrefabsPlugin
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## proceduralHeightfield — function @experimental
-```
-(p: ProceduralParams): Heightfield
-```
-
## projectSideModuleIds — function @experimental
```
(): string[]
@@ -14075,11 +13827,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## rng — function @experimental
-```
-(seed: number): () => number
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -14100,11 +13847,6 @@ PrefabsPlugin
SafeAreaPlugin
```
-## sampleHeight — function @experimental
-```
-(field: Heightfield, u: number, v: number): number
-```
-
## sampleKeyframes — function @experimental
```
(keys: readonly Keyframe[], at: number): number
@@ -14130,11 +13872,6 @@ SafeAreaPlugin
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## scatterCell — function @experimental
-```
-(p: ScatterParams, ground: Ground): Plant[]
-```
-
## sceneAmbientLights — function @experimental
```
(entities: readonly EnvironmentLightEntity[], exists: (ref: string) => boolean): SceneAmbientLight[]
@@ -14590,16 +14327,6 @@ StatsPlugin
(ctx?: CensusContext): Census
```
-## terrainNormal — function @experimental
-```
-(field: Heightfield, u: number, v: number, sizeX: number, sizeZ: number, heightScale: number): [number, number, number]
-```
-
-## terrainPlugin — const @experimental
-```
-Plugin
-```
-
## textInputPlugin — const @experimental
```
TextInputPlugin
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index a1333ff3b..c5f4ba3d9 100644
--- a/sdk/etc/index.native.api.md
+++ b/sdk/etc/index.native.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/index.native
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 115 public · 164 beta · 1725 experimental · 3 deprecated
+Symbols: 115 public · 164 beta · 1690 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -1640,15 +1640,6 @@ op: CompareOp
value: string | number | boolean | undefined
```
-## BladeParams — interface @experimental
-```
-height: number
-paint: { base: [number, number, number]; tip: [number, number, number]; } | null | undefined
-segments: number
-thin: number
-width: number
-```
-
## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
@@ -2180,14 +2171,6 @@ rgb: Float32Array<ArrayBufferLike>
width: number
```
-## CardRect — interface @experimental
-```
-u0: number
-u1: number
-v0: number
-v1: number
-```
-
## Catalog — class @experimental
```
addressOf: (path: string) => string | null
@@ -4048,59 +4031,6 @@ isFocused: boolean
tabIndex: number
```
-## Foliage — const @experimental
-```
-ComponentDef<FoliageData>
-```
-
-## FoliageData — interface @experimental
-```
-bladeHeight: number
-bladeWidth: number
-cardTent: number
-cardU0: number
-cardU1: number
-cardV0: number
-cardV1: number
-cellSize: number
-count: number
-drawDistance: number
-heightMax: number
-heightMin: number
-lodDistance: number
-material: number
-maxScale: number
-mesh: number
-minScale: number
-minUp: number
-seed: number
-sizeX: number
-sizeZ: number
-```
-
-## FoliageField — class @experimental
-```
-@internal built_: Map<number, BuiltFoliage>
-cellCount: number
-pending: number
-static new (): FoliageField
-static prototype: FoliageField
-```
-
-## FoliagePlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): FoliagePlugin
-static prototype: FoliagePlugin
-```
-
-## FoliageRes — const @experimental
-```
-ResourceDef<FoliageField>
-```
-
## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
@@ -4455,11 +4385,6 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## Ground — type @experimental
-```
-(x: number, z: number) => { y: number; up: number } | null
-```
-
## HdrFormat — interface @experimental
```
effective: string
@@ -4475,13 +4400,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Heightfield — interface @experimental
-```
-data: Float32Array<ArrayBufferLike>
-height: number
-width: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -6516,17 +6434,6 @@ updated: boolean | undefined
width: number | undefined
```
-## Plant — interface @experimental
-```
-phase: number
-scale: number
-shade: number
-x: number
-y: number
-yaw: number
-z: number
-```
-
## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
@@ -7123,16 +7030,6 @@ fingerprint: string
pending: PendingSystemEntry[]
```
-## ProceduralParams — interface @experimental
-```
-frequency: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-seed: number
-```
-
## ProcessedEntity — interface @experimental
```
children: number[]
@@ -7984,21 +7881,6 @@ setJSON: <T>(key: string, value: T) => void
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## 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
-```
-
## SceneAmbientLight — interface @experimental
```
drawEnvironment: boolean
@@ -9608,81 +9490,6 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## Terrain — const @experimental
-```
-ComponentDef<TerrainData>
-```
-
-## TerrainData — interface @experimental
-```
-chunkCells: number
-chunks: number
-detail: number
-dirtHeight: number
-frequency: number
-height: number
-heightmap: number
-layerColor0: Color
-layerColor1: Color
-layerColor2: Color
-layerColor3: Color
-lodLevels: number
-material: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-rockSlope: number
-seed: number
-sizeX: number
-sizeZ: number
-snowHeight: number
-splatmap: number
-```
-
-## TerrainPaint — type @experimental
-```
-(
- u: number, v: number, height01: number, slope: number,
-) => [number, number, number, number]
-```
-
-## TerrainPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): TerrainPlugin
-static prototype: TerrainPlugin
-```
-
-## TerrainShape — interface @experimental
-```
-chunkCells: number
-chunks: number
-height: number
-sizeX: number
-sizeZ: number
-```
-
-## Terrains — class @experimental
-```
-@internal app_: App | null
-@internal built_: Map<number, Built>
-@internal revision_: number
-heightAt: (x: number, z: number) => number | null
-loading: boolean
-normalAt: (x: number, z: number) => [number, number, number] | null
-pending: number
-static new (): Terrains
-static prototype: Terrains
-```
-
-## TerrainsRes — const @experimental
-```
-ResourceDef<Terrains>
-```
-
## Text — const @public
```
ComponentDef<TextData>
@@ -12038,31 +11845,11 @@ MotionDriver<AnimatorBlend2DMotion>
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildBillboardMesh — function @experimental
-```
-(plants: readonly Plant[], width: number, height: number, rect: CardRect, paint?: BladeParams["paint"], triangle?: boolean): MeshData
-```
-
-## buildChunkMesh — function @experimental
-```
-(field: Heightfield, shape: TerrainShape, cx: number, cz: number, lod: number, paint: TerrainPaint): MeshData
-```
-
## buildFrameProfile — function @experimental
```
(input: FrameProfileInput): FrameProfile
```
-## buildGrassMesh — function @experimental
-```
-(plants: readonly Plant[], blade: BladeParams): MeshData
-```
-
-## buildInstancedMesh — function @experimental
-```
-(source: MeshData, plants: readonly Plant[], paint?: BladeParams["paint"]): MeshData
-```
-
## buildText — function @experimental
```
(init?: TextInit): TextData
@@ -12173,21 +11960,11 @@ MotionDriver<AnimatorBlend2DMotion>
(cellX: number, cellZ: number, cellSize: number): { minX: number; minZ: number; maxX: number; maxZ: number; }
```
-## cellsAtLod — function @experimental
-```
-(shape: TerrainShape, lod: number): number
-```
-
## censusProbeIds — function @experimental
```
(): string[]
```
-## chunkCenter — function @experimental
-```
-(shape: TerrainShape, cx: number, cz: number): [number, number]
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -12993,11 +12770,6 @@ FocusPlugin
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## foliagePlugin — const @experimental
-```
-Plugin
-```
-
## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
@@ -13238,11 +13010,6 @@ Plugin
() => Plugin[]
```
-## heightfieldFromPixels — function @experimental
-```
-(width: number, height: number, pixels: ArrayLike<number>): Heightfield
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -13553,11 +13320,6 @@ LifecyclePlugin
LocalizationPlugin
```
-## lodCount — function @experimental
-```
-(shape: TerrainShape, wanted?: number): number
-```
-
## log — const @experimental
```
Logger
@@ -13723,11 +13485,6 @@ MeshRendererPlugin
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit" | "aot" | "debugChannel">): { physicsEnabled?: boolean; physicsConfig?: Physics2DPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; aot?: PackagedGameConfig["aot"]; debugChannel?: DebugChannelConfig; }
```
-## paintWeights — function @experimental
-```
-(h: number, ny: number, t: Pick<TerrainData, "rockSlope" | "dirtHeight" | "snowHeight">): [number, number, number, number]
-```
-
## panoramaDirection — function @experimental
```
(u: number, v: number): [number, number, number]
@@ -14018,11 +13775,6 @@ PrefabsPlugin
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## proceduralHeightfield — function @experimental
-```
-(p: ProceduralParams): Heightfield
-```
-
## projectSideModuleIds — function @experimental
```
(): string[]
@@ -14338,11 +14090,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## rng — function @experimental
-```
-(seed: number): () => number
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -14363,11 +14110,6 @@ PrefabsPlugin
SafeAreaPlugin
```
-## sampleHeight — function @experimental
-```
-(field: Heightfield, u: number, v: number): number
-```
-
## sampleKeyframes — function @experimental
```
(keys: readonly Keyframe[], at: number): number
@@ -14393,11 +14135,6 @@ SafeAreaPlugin
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## scatterCell — function @experimental
-```
-(p: ScatterParams, ground: Ground): Plant[]
-```
-
## sceneAmbientLights — function @experimental
```
(entities: readonly EnvironmentLightEntity[], exists: (ref: string) => boolean): SceneAmbientLight[]
@@ -14853,16 +14590,6 @@ StatsPlugin
(ctx?: CensusContext): Census
```
-## terrainNormal — function @experimental
-```
-(field: Heightfield, u: number, v: number, sizeX: number, sizeZ: number, heightScale: number): [number, number, number]
-```
-
-## terrainPlugin — const @experimental
-```
-Plugin
-```
-
## textInputPlugin — const @experimental
```
TextInputPlugin
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index ff267e6d3..7e1a3cebc 100644
--- a/sdk/etc/index.node.api.md
+++ b/sdk/etc/index.node.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/index.node
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 115 public · 161 beta · 1705 experimental · 3 deprecated
+Symbols: 115 public · 161 beta · 1670 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1635,15 +1635,6 @@ op: CompareOp
value: string | number | boolean | undefined
```
-## BladeParams — interface @experimental
-```
-height: number
-paint: { base: [number, number, number]; tip: [number, number, number]; } | null | undefined
-segments: number
-thin: number
-width: number
-```
-
## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
@@ -2175,14 +2166,6 @@ rgb: Float32Array<ArrayBufferLike>
width: number
```
-## CardRect — interface @experimental
-```
-u0: number
-u1: number
-v0: number
-v1: number
-```
-
## Catalog — class @experimental
```
addressOf: (path: string) => string | null
@@ -4035,59 +4018,6 @@ isFocused: boolean
tabIndex: number
```
-## Foliage — const @experimental
-```
-ComponentDef<FoliageData>
-```
-
-## FoliageData — interface @experimental
-```
-bladeHeight: number
-bladeWidth: number
-cardTent: number
-cardU0: number
-cardU1: number
-cardV0: number
-cardV1: number
-cellSize: number
-count: number
-drawDistance: number
-heightMax: number
-heightMin: number
-lodDistance: number
-material: number
-maxScale: number
-mesh: number
-minScale: number
-minUp: number
-seed: number
-sizeX: number
-sizeZ: number
-```
-
-## FoliageField — class @experimental
-```
-@internal built_: Map<number, BuiltFoliage>
-cellCount: number
-pending: number
-static new (): FoliageField
-static prototype: FoliageField
-```
-
-## FoliagePlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): FoliagePlugin
-static prototype: FoliagePlugin
-```
-
-## FoliageRes — const @experimental
-```
-ResourceDef<FoliageField>
-```
-
## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
@@ -4442,11 +4372,6 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## Ground — type @experimental
-```
-(x: number, z: number) => { y: number; up: number } | null
-```
-
## HdrFormat — interface @experimental
```
effective: string
@@ -4462,13 +4387,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Heightfield — interface @experimental
-```
-data: Float32Array<ArrayBufferLike>
-height: number
-width: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -6308,17 +6226,6 @@ updated: boolean | undefined
width: number | undefined
```
-## Plant — interface @experimental
-```
-phase: number
-scale: number
-shade: number
-x: number
-y: number
-yaw: number
-z: number
-```
-
## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
@@ -6915,16 +6822,6 @@ fingerprint: string
pending: PendingSystemEntry[]
```
-## ProceduralParams — interface @experimental
-```
-frequency: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-seed: number
-```
-
## ProcessedEntity — interface @experimental
```
children: number[]
@@ -7766,21 +7663,6 @@ setJSON: <T>(key: string, value: T) => void
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## 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
-```
-
## SceneAmbientLight — interface @experimental
```
drawEnvironment: boolean
@@ -9390,81 +9272,6 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## Terrain — const @experimental
-```
-ComponentDef<TerrainData>
-```
-
-## TerrainData — interface @experimental
-```
-chunkCells: number
-chunks: number
-detail: number
-dirtHeight: number
-frequency: number
-height: number
-heightmap: number
-layerColor0: Color
-layerColor1: Color
-layerColor2: Color
-layerColor3: Color
-lodLevels: number
-material: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-rockSlope: number
-seed: number
-sizeX: number
-sizeZ: number
-snowHeight: number
-splatmap: number
-```
-
-## TerrainPaint — type @experimental
-```
-(
- u: number, v: number, height01: number, slope: number,
-) => [number, number, number, number]
-```
-
-## TerrainPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): TerrainPlugin
-static prototype: TerrainPlugin
-```
-
-## TerrainShape — interface @experimental
-```
-chunkCells: number
-chunks: number
-height: number
-sizeX: number
-sizeZ: number
-```
-
-## Terrains — class @experimental
-```
-@internal app_: App | null
-@internal built_: Map<number, Built>
-@internal revision_: number
-heightAt: (x: number, z: number) => number | null
-loading: boolean
-normalAt: (x: number, z: number) => [number, number, number] | null
-pending: number
-static new (): Terrains
-static prototype: Terrains
-```
-
-## TerrainsRes — const @experimental
-```
-ResourceDef<Terrains>
-```
-
## Text — const @public
```
ComponentDef<TextData>
@@ -11805,31 +11612,11 @@ MotionDriver<AnimatorBlend2DMotion>
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildBillboardMesh — function @experimental
-```
-(plants: readonly Plant[], width: number, height: number, rect: CardRect, paint?: BladeParams["paint"], triangle?: boolean): MeshData
-```
-
-## buildChunkMesh — function @experimental
-```
-(field: Heightfield, shape: TerrainShape, cx: number, cz: number, lod: number, paint: TerrainPaint): MeshData
-```
-
## buildFrameProfile — function @experimental
```
(input: FrameProfileInput): FrameProfile
```
-## buildGrassMesh — function @experimental
-```
-(plants: readonly Plant[], blade: BladeParams): MeshData
-```
-
-## buildInstancedMesh — function @experimental
-```
-(source: MeshData, plants: readonly Plant[], paint?: BladeParams["paint"]): MeshData
-```
-
## buildText — function @experimental
```
(init?: TextInit): TextData
@@ -11940,21 +11727,11 @@ MotionDriver<AnimatorBlend2DMotion>
(cellX: number, cellZ: number, cellSize: number): { minX: number; minZ: number; maxX: number; maxZ: number; }
```
-## cellsAtLod — function @experimental
-```
-(shape: TerrainShape, lod: number): number
-```
-
## censusProbeIds — function @experimental
```
(): string[]
```
-## chunkCenter — function @experimental
-```
-(shape: TerrainShape, cx: number, cz: number): [number, number]
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -12735,11 +12512,6 @@ FocusPlugin
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## foliagePlugin — const @experimental
-```
-Plugin
-```
-
## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
@@ -12980,11 +12752,6 @@ Plugin
() => Plugin[]
```
-## heightfieldFromPixels — function @experimental
-```
-(width: number, height: number, pixels: ArrayLike<number>): Heightfield
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -13290,11 +13057,6 @@ LifecyclePlugin
LocalizationPlugin
```
-## lodCount — function @experimental
-```
-(shape: TerrainShape, wanted?: number): number
-```
-
## log — const @experimental
```
Logger
@@ -13465,11 +13227,6 @@ NodePlatformAdapter
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit" | "aot" | "debugChannel">): { physicsEnabled?: boolean; physicsConfig?: Physics2DPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; aot?: PackagedGameConfig["aot"]; debugChannel?: DebugChannelConfig; }
```
-## paintWeights — function @experimental
-```
-(h: number, ny: number, t: Pick<TerrainData, "rockSlope" | "dirtHeight" | "snowHeight">): [number, number, number, number]
-```
-
## panoramaDirection — function @experimental
```
(u: number, v: number): [number, number, number]
@@ -13760,11 +13517,6 @@ PrefabsPlugin
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## proceduralHeightfield — function @experimental
-```
-(p: ProceduralParams): Heightfield
-```
-
## projectSideModuleIds — function @experimental
```
(): string[]
@@ -14080,11 +13832,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## rng — function @experimental
-```
-(seed: number): () => number
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -14105,11 +13852,6 @@ PrefabsPlugin
SafeAreaPlugin
```
-## sampleHeight — function @experimental
-```
-(field: Heightfield, u: number, v: number): number
-```
-
## sampleKeyframes — function @experimental
```
(keys: readonly Keyframe[], at: number): number
@@ -14135,11 +13877,6 @@ SafeAreaPlugin
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## scatterCell — function @experimental
-```
-(p: ScatterParams, ground: Ground): Plant[]
-```
-
## sceneAmbientLights — function @experimental
```
(entities: readonly EnvironmentLightEntity[], exists: (ref: string) => boolean): SceneAmbientLight[]
@@ -14595,16 +14332,6 @@ StatsPlugin
(ctx?: CensusContext): Census
```
-## terrainNormal — function @experimental
-```
-(field: Heightfield, u: number, v: number, sizeX: number, sizeZ: number, heightScale: number): [number, number, number]
-```
-
-## terrainPlugin — const @experimental
-```
-Plugin
-```
-
## textInputPlugin — const @experimental
```
TextInputPlugin
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index cd2ecd6c7..0d5a9e779 100644
--- a/sdk/etc/minigame.api.md
+++ b/sdk/etc/minigame.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/minigame
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 115 public · 159 beta · 1727 experimental · 3 deprecated
+Symbols: 115 public · 159 beta · 1692 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1635,15 +1635,6 @@ op: CompareOp
value: string | number | boolean | undefined
```
-## BladeParams — interface @experimental
-```
-height: number
-paint: { base: [number, number, number]; tip: [number, number, number]; } | null | undefined
-segments: number
-thin: number
-width: number
-```
-
## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
@@ -2175,14 +2166,6 @@ rgb: Float32Array<ArrayBufferLike>
width: number
```
-## CardRect — interface @experimental
-```
-u0: number
-u1: number
-v0: number
-v1: number
-```
-
## Catalog — class @experimental
```
addressOf: (path: string) => string | null
@@ -4035,59 +4018,6 @@ isFocused: boolean
tabIndex: number
```
-## Foliage — const @experimental
-```
-ComponentDef<FoliageData>
-```
-
-## FoliageData — interface @experimental
-```
-bladeHeight: number
-bladeWidth: number
-cardTent: number
-cardU0: number
-cardU1: number
-cardV0: number
-cardV1: number
-cellSize: number
-count: number
-drawDistance: number
-heightMax: number
-heightMin: number
-lodDistance: number
-material: number
-maxScale: number
-mesh: number
-minScale: number
-minUp: number
-seed: number
-sizeX: number
-sizeZ: number
-```
-
-## FoliageField — class @experimental
-```
-@internal built_: Map<number, BuiltFoliage>
-cellCount: number
-pending: number
-static new (): FoliageField
-static prototype: FoliageField
-```
-
-## FoliagePlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): FoliagePlugin
-static prototype: FoliagePlugin
-```
-
-## FoliageRes — const @experimental
-```
-ResourceDef<FoliageField>
-```
-
## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
@@ -4442,11 +4372,6 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## Ground — type @experimental
-```
-(x: number, z: number) => { y: number; up: number } | null
-```
-
## HdrFormat — interface @experimental
```
effective: string
@@ -4462,13 +4387,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Heightfield — interface @experimental
-```
-data: Float32Array<ArrayBufferLike>
-height: number
-width: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -6601,17 +6519,6 @@ updated: boolean | undefined
width: number | undefined
```
-## Plant — interface @experimental
-```
-phase: number
-scale: number
-shade: number
-x: number
-y: number
-yaw: number
-z: number
-```
-
## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
@@ -7208,16 +7115,6 @@ fingerprint: string
pending: PendingSystemEntry[]
```
-## ProceduralParams — interface @experimental
-```
-frequency: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-seed: number
-```
-
## ProcessedEntity — interface @experimental
```
children: number[]
@@ -8059,21 +7956,6 @@ setJSON: <T>(key: string, value: T) => void
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## 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
-```
-
## SceneAmbientLight — interface @experimental
```
drawEnvironment: boolean
@@ -9683,81 +9565,6 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## Terrain — const @experimental
-```
-ComponentDef<TerrainData>
-```
-
-## TerrainData — interface @experimental
-```
-chunkCells: number
-chunks: number
-detail: number
-dirtHeight: number
-frequency: number
-height: number
-heightmap: number
-layerColor0: Color
-layerColor1: Color
-layerColor2: Color
-layerColor3: Color
-lodLevels: number
-material: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-rockSlope: number
-seed: number
-sizeX: number
-sizeZ: number
-snowHeight: number
-splatmap: number
-```
-
-## TerrainPaint — type @experimental
-```
-(
- u: number, v: number, height01: number, slope: number,
-) => [number, number, number, number]
-```
-
-## TerrainPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): TerrainPlugin
-static prototype: TerrainPlugin
-```
-
-## TerrainShape — interface @experimental
-```
-chunkCells: number
-chunks: number
-height: number
-sizeX: number
-sizeZ: number
-```
-
-## Terrains — class @experimental
-```
-@internal app_: App | null
-@internal built_: Map<number, Built>
-@internal revision_: number
-heightAt: (x: number, z: number) => number | null
-loading: boolean
-normalAt: (x: number, z: number) => [number, number, number] | null
-pending: number
-static new (): Terrains
-static prototype: Terrains
-```
-
-## TerrainsRes — const @experimental
-```
-ResourceDef<Terrains>
-```
-
## Text — const @public
```
ComponentDef<TextData>
@@ -12104,31 +11911,11 @@ MotionDriver<AnimatorBlend2DMotion>
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildBillboardMesh — function @experimental
-```
-(plants: readonly Plant[], width: number, height: number, rect: CardRect, paint?: BladeParams["paint"], triangle?: boolean): MeshData
-```
-
-## buildChunkMesh — function @experimental
-```
-(field: Heightfield, shape: TerrainShape, cx: number, cz: number, lod: number, paint: TerrainPaint): MeshData
-```
-
## buildFrameProfile — function @experimental
```
(input: FrameProfileInput): FrameProfile
```
-## buildGrassMesh — function @experimental
-```
-(plants: readonly Plant[], blade: BladeParams): MeshData
-```
-
-## buildInstancedMesh — function @experimental
-```
-(source: MeshData, plants: readonly Plant[], paint?: BladeParams["paint"]): MeshData
-```
-
## buildText — function @experimental
```
(init?: TextInit): TextData
@@ -12239,21 +12026,11 @@ MotionDriver<AnimatorBlend2DMotion>
(cellX: number, cellZ: number, cellSize: number): { minX: number; minZ: number; maxX: number; maxZ: number; }
```
-## cellsAtLod — function @experimental
-```
-(shape: TerrainShape, lod: number): number
-```
-
## censusProbeIds — function @experimental
```
(): string[]
```
-## chunkCenter — function @experimental
-```
-(shape: TerrainShape, cx: number, cz: number): [number, number]
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -13039,11 +12816,6 @@ FocusPlugin
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## foliagePlugin — const @experimental
-```
-Plugin
-```
-
## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
@@ -13284,11 +13056,6 @@ Plugin
() => Plugin[]
```
-## heightfieldFromPixels — function @experimental
-```
-(width: number, height: number, pixels: ArrayLike<number>): Heightfield
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -13599,11 +13366,6 @@ LifecyclePlugin
LocalizationPlugin
```
-## lodCount — function @experimental
-```
-(shape: TerrainShape, wanted?: number): number
-```
-
## log — const @experimental
```
Logger
@@ -13769,11 +13531,6 @@ MeshRendererPlugin
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit" | "aot" | "debugChannel">): { physicsEnabled?: boolean; physicsConfig?: Physics2DPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; aot?: PackagedGameConfig["aot"]; debugChannel?: DebugChannelConfig; }
```
-## paintWeights — function @experimental
-```
-(h: number, ny: number, t: Pick<TerrainData, "rockSlope" | "dirtHeight" | "snowHeight">): [number, number, number, number]
-```
-
## panoramaDirection — function @experimental
```
(u: number, v: number): [number, number, number]
@@ -14064,11 +13821,6 @@ PrefabsPlugin
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## proceduralHeightfield — function @experimental
-```
-(p: ProceduralParams): Heightfield
-```
-
## projectSideModuleIds — function @experimental
```
(): string[]
@@ -14384,11 +14136,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## rng — function @experimental
-```
-(seed: number): () => number
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -14409,11 +14156,6 @@ PrefabsPlugin
SafeAreaPlugin
```
-## sampleHeight — function @experimental
-```
-(field: Heightfield, u: number, v: number): number
-```
-
## sampleKeyframes — function @experimental
```
(keys: readonly Keyframe[], at: number): number
@@ -14439,11 +14181,6 @@ SafeAreaPlugin
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## scatterCell — function @experimental
-```
-(p: ScatterParams, ground: Ground): Plant[]
-```
-
## sceneAmbientLights — function @experimental
```
(entities: readonly EnvironmentLightEntity[], exists: (ref: string) => boolean): SceneAmbientLight[]
@@ -14899,16 +14636,6 @@ StatsPlugin
(ctx?: CensusContext): Census
```
-## terrainNormal — function @experimental
-```
-(field: Heightfield, u: number, v: number, sizeX: number, sizeZ: number, heightScale: number): [number, number, number]
-```
-
-## terrainPlugin — const @experimental
-```
-Plugin
-```
-
## textInputPlugin — const @experimental
```
TextInputPlugin
diff --git a/sdk/etc/terrain.api.md b/sdk/etc/terrain.api.md
new file mode 100644
index 000000000..56bc8f3c6
--- /dev/null
+++ b/sdk/etc/terrain.api.md
@@ -0,0 +1,147 @@
+# API surface — esengine/terrain
+
+<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
+Symbols: 0 public · 0 beta · 19 experimental · 0 deprecated
+
+## Heightfield — interface @experimental
+```
+data: Float32Array<ArrayBufferLike>
+height: number
+width: number
+```
+
+## ProceduralParams — interface @experimental
+```
+frequency: number
+octaves: number
+persistence: number
+resolution: number
+ridged: number
+seed: number
+```
+
+## Terrain — const @experimental
+```
+ComponentDef<TerrainData>
+```
+
+## TerrainData — interface @experimental
+```
+chunkCells: number
+chunks: number
+detail: number
+dirtHeight: number
+frequency: number
+height: number
+heightmap: number
+layerColor0: Color
+layerColor1: Color
+layerColor2: Color
+layerColor3: Color
+lodLevels: number
+material: number
+octaves: number
+persistence: number
+resolution: number
+ridged: number
+rockSlope: number
+seed: number
+sizeX: number
+sizeZ: number
+snowHeight: number
+splatmap: number
+```
+
+## TerrainPaint — type @experimental
+```
+(
+ u: number, v: number, height01: number, slope: number,
+) => [number, number, number, number]
+```
+
+## TerrainPlugin — class @experimental
+```
+build: (app: App) => void
+cleanup: (app?: App) => void
+name: string
+static new (): TerrainPlugin
+static prototype: TerrainPlugin
+```
+
+## TerrainShape — interface @experimental
+```
+chunkCells: number
+chunks: number
+height: number
+sizeX: number
+sizeZ: number
+```
+
+## Terrains — class @experimental
+```
+@internal app_: App | null
+@internal built_: Map<number, Built>
+@internal revision_: number
+heightAt: (x: number, z: number) => number | null
+loading: boolean
+normalAt: (x: number, z: number) => [number, number, number] | null
+pending: number
+static new (): Terrains
+static prototype: Terrains
+```
+
+## TerrainsRes — const @experimental
+```
+ResourceDef<Terrains>
+```
+
+## buildChunkMesh — function @experimental
+```
+(field: Heightfield, shape: TerrainShape, cx: number, cz: number, lod: number, paint: TerrainPaint): MeshData
+```
+
+## cellsAtLod — function @experimental
+```
+(shape: TerrainShape, lod: number): number
+```
+
+## chunkCenter — function @experimental
+```
+(shape: TerrainShape, cx: number, cz: number): [number, number]
+```
+
+## heightfieldFromPixels — function @experimental
+```
+(width: number, height: number, pixels: ArrayLike<number>): Heightfield
+```
+
+## lodCount — function @experimental
+```
+(shape: TerrainShape, wanted?: number): number
+```
+
+## paintWeights — function @experimental
+```
+(h: number, ny: number, t: Pick<TerrainData, "rockSlope" | "dirtHeight" | "snowHeight">): [number, number, number, number]
+```
+
+## proceduralHeightfield — function @experimental
+```
+(p: ProceduralParams): Heightfield
+```
+
+## sampleHeight — function @experimental
+```
+(field: Heightfield, u: number, v: number): number
+```
+
+## terrainNormal — function @experimental
+```
+(field: Heightfield, u: number, v: number, sizeX: number, sizeZ: number, heightScale: number): [number, number, number]
+```
+
+## terrainPlugin — const @experimental
+```
+Plugin
+```
+
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index af6c3ebf8..b469f52c6 100644
--- a/sdk/etc/wechat.api.md
+++ b/sdk/etc/wechat.api.md
@@ -1,7 +1,7 @@
# API surface — esengine/wechat
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 115 public · 159 beta · 1718 experimental · 3 deprecated
+Symbols: 115 public · 159 beta · 1683 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1635,15 +1635,6 @@ op: CompareOp
value: string | number | boolean | undefined
```
-## BladeParams — interface @experimental
-```
-height: number
-paint: { base: [number, number, number]; tip: [number, number, number]; } | null | undefined
-segments: number
-thin: number
-width: number
-```
-
## BlendCurve — type @experimental
```
(typeof BlendCurve)[keyof typeof BlendCurve]
@@ -2175,14 +2166,6 @@ rgb: Float32Array<ArrayBufferLike>
width: number
```
-## CardRect — interface @experimental
-```
-u0: number
-u1: number
-v0: number
-v1: number
-```
-
## Catalog — class @experimental
```
addressOf: (path: string) => string | null
@@ -4035,59 +4018,6 @@ isFocused: boolean
tabIndex: number
```
-## Foliage — const @experimental
-```
-ComponentDef<FoliageData>
-```
-
-## FoliageData — interface @experimental
-```
-bladeHeight: number
-bladeWidth: number
-cardTent: number
-cardU0: number
-cardU1: number
-cardV0: number
-cardV1: number
-cellSize: number
-count: number
-drawDistance: number
-heightMax: number
-heightMin: number
-lodDistance: number
-material: number
-maxScale: number
-mesh: number
-minScale: number
-minUp: number
-seed: number
-sizeX: number
-sizeZ: number
-```
-
-## FoliageField — class @experimental
-```
-@internal built_: Map<number, BuiltFoliage>
-cellCount: number
-pending: number
-static new (): FoliageField
-static prototype: FoliageField
-```
-
-## FoliagePlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): FoliagePlugin
-static prototype: FoliagePlugin
-```
-
-## FoliageRes — const @experimental
-```
-ResourceDef<FoliageField>
-```
-
## FollowTarget — const @experimental
```
ComponentDef<FollowTargetData>
@@ -4442,11 +4372,6 @@ static new (opts: GridLayoutOptions): GridLayoutProvider
static prototype: GridLayoutProvider
```
-## Ground — type @experimental
-```
-(x: number, z: number) => { y: number; up: number } | null
-```
-
## HdrFormat — interface @experimental
```
effective: string
@@ -4462,13 +4387,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Heightfield — interface @experimental
-```
-data: Float32Array<ArrayBufferLike>
-height: number
-width: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -6315,17 +6233,6 @@ updated: boolean | undefined
width: number | undefined
```
-## Plant — interface @experimental
-```
-phase: number
-scale: number
-shade: number
-x: number
-y: number
-yaw: number
-z: number
-```
-
## PlatformAdapter — interface @experimental
```
bindInputEvents: (callbacks: InputEventCallbacks, target?: unknown) => void
@@ -6922,16 +6829,6 @@ fingerprint: string
pending: PendingSystemEntry[]
```
-## ProceduralParams — interface @experimental
-```
-frequency: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-seed: number
-```
-
## ProcessedEntity — interface @experimental
```
children: number[]
@@ -7773,21 +7670,6 @@ setJSON: <T>(key: string, value: T) => void
(typeof ScaleMode)[keyof typeof ScaleMode]
```
-## 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
-```
-
## SceneAmbientLight — interface @experimental
```
drawEnvironment: boolean
@@ -9397,81 +9279,6 @@ setPaused: (paused: boolean) => void
suspendAudio: () => void
```
-## Terrain — const @experimental
-```
-ComponentDef<TerrainData>
-```
-
-## TerrainData — interface @experimental
-```
-chunkCells: number
-chunks: number
-detail: number
-dirtHeight: number
-frequency: number
-height: number
-heightmap: number
-layerColor0: Color
-layerColor1: Color
-layerColor2: Color
-layerColor3: Color
-lodLevels: number
-material: number
-octaves: number
-persistence: number
-resolution: number
-ridged: number
-rockSlope: number
-seed: number
-sizeX: number
-sizeZ: number
-snowHeight: number
-splatmap: number
-```
-
-## TerrainPaint — type @experimental
-```
-(
- u: number, v: number, height01: number, slope: number,
-) => [number, number, number, number]
-```
-
-## TerrainPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: (app?: App) => void
-name: string
-static new (): TerrainPlugin
-static prototype: TerrainPlugin
-```
-
-## TerrainShape — interface @experimental
-```
-chunkCells: number
-chunks: number
-height: number
-sizeX: number
-sizeZ: number
-```
-
-## Terrains — class @experimental
-```
-@internal app_: App | null
-@internal built_: Map<number, Built>
-@internal revision_: number
-heightAt: (x: number, z: number) => number | null
-loading: boolean
-normalAt: (x: number, z: number) => [number, number, number] | null
-pending: number
-static new (): Terrains
-static prototype: Terrains
-```
-
-## TerrainsRes — const @experimental
-```
-ResourceDef<Terrains>
-```
-
## Text — const @public
```
ComponentDef<TextData>
@@ -11836,31 +11643,11 @@ MotionDriver<AnimatorBlend2DMotion>
(overrides: readonly PrefabOverride[]): Map<PrefabEntityId, PrefabOverride[]>
```
-## buildBillboardMesh — function @experimental
-```
-(plants: readonly Plant[], width: number, height: number, rect: CardRect, paint?: BladeParams["paint"], triangle?: boolean): MeshData
-```
-
-## buildChunkMesh — function @experimental
-```
-(field: Heightfield, shape: TerrainShape, cx: number, cz: number, lod: number, paint: TerrainPaint): MeshData
-```
-
## buildFrameProfile — function @experimental
```
(input: FrameProfileInput): FrameProfile
```
-## buildGrassMesh — function @experimental
-```
-(plants: readonly Plant[], blade: BladeParams): MeshData
-```
-
-## buildInstancedMesh — function @experimental
-```
-(source: MeshData, plants: readonly Plant[], paint?: BladeParams["paint"]): MeshData
-```
-
## buildText — function @experimental
```
(init?: TextInit): TextData
@@ -11971,21 +11758,11 @@ MotionDriver<AnimatorBlend2DMotion>
(cellX: number, cellZ: number, cellSize: number): { minX: number; minZ: number; maxX: number; maxZ: number; }
```
-## cellsAtLod — function @experimental
-```
-(shape: TerrainShape, lod: number): number
-```
-
## censusProbeIds — function @experimental
```
(): string[]
```
-## chunkCenter — function @experimental
-```
-(shape: TerrainShape, cx: number, cz: number): [number, number]
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -12766,11 +12543,6 @@ FocusPlugin
(config: AssetGroupsConfig | null | undefined, folder: string): AssetGroupMode
```
-## foliagePlugin — const @experimental
-```
-Plugin
-```
-
## formatActionArg — function @experimental
```
(params: Readonly<Record<string, AiParamValue>> | undefined, defs: readonly AiParamDef[], separator?: string): string | undefined
@@ -13011,11 +12783,6 @@ Plugin
() => Plugin[]
```
-## heightfieldFromPixels — function @experimental
-```
-(width: number, height: number, pixels: ArrayLike<number>): Heightfield
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -13326,11 +13093,6 @@ LifecyclePlugin
LocalizationPlugin
```
-## lodCount — function @experimental
-```
-(shape: TerrainShape, wanted?: number): number
-```
-
## log — const @experimental
```
Logger
@@ -13496,11 +13258,6 @@ MeshRendererPlugin
(config: Pick<PackagedGameConfig, "physicsEnabled" | "physicsConfig" | "audioConfig" | "uiTheme" | "uiThemeColors" | "achievements" | "steamAppId" | "screenFit" | "aot" | "debugChannel">): { physicsEnabled?: boolean; physicsConfig?: Physics2DPluginConfig; audioConfig?: AudioProjectConfig; uiTheme?: "light"; uiThemeOverrides?: ThemeOverrides; achievements?: string[]; steamAppId?: number; screenFit?: PackagedGameConfig["screenFit"]; aot?: PackagedGameConfig["aot"]; debugChannel?: DebugChannelConfig; }
```
-## paintWeights — function @experimental
-```
-(h: number, ny: number, t: Pick<TerrainData, "rockSlope" | "dirtHeight" | "snowHeight">): [number, number, number, number]
-```
-
## panoramaDirection — function @experimental
```
(u: number, v: number): [number, number, number]
@@ -13791,11 +13548,6 @@ PrefabsPlugin
(register: () => Promise<void>): Promise<ProbedRegistrations>
```
-## proceduralHeightfield — function @experimental
-```
-(p: ProceduralParams): Heightfield
-```
-
## projectSideModuleIds — function @experimental
```
(): string[]
@@ -14111,11 +13863,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## rng — function @experimental
-```
-(seed: number): () => number
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -14136,11 +13883,6 @@ PrefabsPlugin
SafeAreaPlugin
```
-## sampleHeight — function @experimental
-```
-(field: Heightfield, u: number, v: number): number
-```
-
## sampleKeyframes — function @experimental
```
(keys: readonly Keyframe[], at: number): number
@@ -14166,11 +13908,6 @@ SafeAreaPlugin
{ readonly clamp: (x: number, min: number, max: number) => number; readonly clamp01: (x: number) => number; readonly lerp: (a: number, b: number, t: number) => number; readonly inverseLerp: (a: number, b: number, value: number) => number; readonly remap: (value: number, inMin: number, inMax: number, outMin: number, outMax: number) => number; readonly deg2rad: (deg: number) => number; readonly rad2deg: (rad: number) => number; readonly approximately: (a: number, b: number, epsilon?: number) => boolean; readonly smoothstep: (edge0: number, edge1: number, x: number) => number; readonly mod: (x: number, n: number) => number; readonly sign: (x: number) => number; }
```
-## scatterCell — function @experimental
-```
-(p: ScatterParams, ground: Ground): Plant[]
-```
-
## sceneAmbientLights — function @experimental
```
(entities: readonly EnvironmentLightEntity[], exists: (ref: string) => boolean): SceneAmbientLight[]
@@ -14626,16 +14363,6 @@ StatsPlugin
(ctx?: CensusContext): Census
```
-## terrainNormal — function @experimental
-```
-(field: Heightfield, u: number, v: number, sizeX: number, sizeZ: number, heightScale: number): [number, number, number]
-```
-
-## terrainPlugin — const @experimental
-```
-Plugin
-```
-
## textInputPlugin — const @experimental
```
TextInputPlugin
diff --git a/sdk/package.json b/sdk/package.json
index a016f0a25..474d8f581 100644
--- a/sdk/package.json
+++ b/sdk/package.json
@@ -17,6 +17,8 @@
"./dist/dragonbones/index.js",
"./dist/spine/index.js",
"./dist/tilemap/index.js",
+ "./dist/terrain/index.js",
+ "./dist/foliage/index.js",
"./dist/logic/index.js",
"./dist/debug-channel/index.js",
"./dist/ai/index.js",
@@ -71,6 +73,14 @@
"import": "./dist/tilemap/index.js",
"types": "./dist/tilemap/index.d.ts"
},
+ "./terrain": {
+ "import": "./dist/terrain/index.js",
+ "types": "./dist/terrain/index.d.ts"
+ },
+ "./foliage": {
+ "import": "./dist/foliage/index.js",
+ "types": "./dist/foliage/index.d.ts"
+ },
"./logic": {
"import": "./dist/logic/index.js",
"types": "./dist/logic/index.d.ts"
diff --git a/sdk/rolldown.config.js b/sdk/rolldown.config.js
index 2445e2a19..ce2b14fb8 100644
--- a/sdk/rolldown.config.js
+++ b/sdk/rolldown.config.js
@@ -97,6 +97,8 @@ export default defineConfig([
'physics3d/index': 'src/physics3d/index.ts',
'spine/index': 'src/spine/index.ts',
'tilemap/index': 'src/tilemap/index.ts',
+ 'terrain/index': 'src/terrain/index.ts',
+ 'foliage/index': 'src/foliage/index.ts',
'logic/index': 'src/logic/index.ts',
'debug-channel/index': 'src/debug-channel/index.ts',
'ai/index': 'src/ai/index.ts',
diff --git a/sdk/src/app/pluginSets.ts b/sdk/src/app/pluginSets.ts
index 5e0ebffe2..d5b1bd275 100644
--- a/sdk/src/app/pluginSets.ts
+++ b/sdk/src/app/pluginSets.ts
@@ -28,8 +28,6 @@ import { particlePlugin } from '../particle';
import { trailPlugin } from '../trail';
import { meshRendererPlugin } from '../render/meshRenderer';
import { staticBatchPlugin } from '../render/staticBatchPlugin';
-import { terrainPlugin } from '../terrain/terrainPlugin';
-import { foliagePlugin } from '../foliage/foliagePlugin';
import { postProcessPlugin } from '../postprocess';
import { timelinePlugin } from '../timeline';
import { timerPlugin } from '../ecs/timer';
@@ -59,7 +57,7 @@ export const simulationBasePlugins = (): Plugin[] => [
/** What exists to be seen. Every entry drives the engine through `engineApi`. */
export const presentationBasePlugins = (): Plugin[] => [
- animationPlugin, videoPlugin, particlePlugin, trailPlugin, meshRendererPlugin, staticBatchPlugin, terrainPlugin, foliagePlugin,
+ animationPlugin, videoPlugin, particlePlugin, trailPlugin, meshRendererPlugin, staticBatchPlugin,
postProcessPlugin, timelinePlugin,
];
@@ -96,7 +94,7 @@ export function inBuildOrder(plugins: readonly Plugin[]): Plugin[] {
export const webBasePlugins = (): Plugin[] => [
diagnosticsPlugin,
timerPlugin, velocityPlugin, lifecyclePlugin, animationPlugin, audioPlugin, videoPlugin,
- particlePlugin, trailPlugin, meshRendererPlugin, staticBatchPlugin, terrainPlugin, foliagePlugin, postProcessPlugin, timelinePlugin,
+ particlePlugin, trailPlugin, meshRendererPlugin, staticBatchPlugin, postProcessPlugin, timelinePlugin,
eventBindingPlugin,
servicesPlugin,
];
diff --git a/sdk/src/core-content.ts b/sdk/src/core-content.ts
index 40c5592f7..284d860b1 100644
--- a/sdk/src/core-content.ts
+++ b/sdk/src/core-content.ts
@@ -779,23 +779,7 @@ export {
StaticBatch, StaticBatching, StaticBatchingRes, StaticBatchPlugin, staticBatchPlugin,
StaticBatchState, type StaticBatchData, type StaticBatchSummary,
} from './render/staticBatchPlugin';
-export {
- Terrain, Terrains, TerrainsRes, TerrainPlugin, terrainPlugin, paintWeights, type TerrainData,
-} from './terrain/terrainPlugin';
-export {
- Foliage, FoliageField, FoliageRes, FoliagePlugin, foliagePlugin, type FoliageData,
-} from './foliage/foliagePlugin';
-export {
- scatterCell, buildGrassMesh, buildInstancedMesh, buildBillboardMesh, rng,
- type Plant, type Ground, type ScatterParams, type BladeParams, type CardRect,
-} from './foliage/builder';
-export {
- heightfieldFromPixels, proceduralHeightfield, sampleHeight, terrainNormal,
- type Heightfield, type ProceduralParams,
-} from './terrain/heightfield';
-export {
- buildChunkMesh, cellsAtLod, chunkCenter, lodCount, type TerrainShape, type TerrainPaint,
-} from './terrain/mesh';
+// Terrain and Foliage are optional modules: `esengine/terrain` and `esengine/foliage`.
export {
mergeMeshes, planStaticBatches, STATIC_BATCH_DEFAULTS,
type StaticBatchGroup, type StaticBatchLimits, type StaticBatchRefusal, type StaticBatchReport,
diff --git a/sdk/src/foliage/foliageSupport.ts b/sdk/src/foliage/foliageSupport.ts
new file mode 100644
index 000000000..77242223a
--- /dev/null
+++ b/sdk/src/foliage/foliageSupport.ts
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file foliageSupport.ts — what a build that ships foliage tells the core.
+ *
+ * A call, not a file's side effect — see tilemap/tilemapSupport.ts.
+ */
+import { addEntryPlugin } from '../runtime/entryPlugins';
+import { FoliagePlugin } from './foliagePlugin';
+
+export function registerFoliageSupport(): void {
+ addEntryPlugin('foliage', () => new FoliagePlugin());
+}
diff --git a/sdk/src/foliage/index.ts b/sdk/src/foliage/index.ts
new file mode 100644
index 000000000..a7bda1c8b
--- /dev/null
+++ b/sdk/src/foliage/index.ts
@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+export {
+ Foliage, FoliageField, FoliageRes, FoliagePlugin, foliagePlugin, type FoliageData,
+} from './foliagePlugin';
+export {
+ scatterCell, buildGrassMesh, buildInstancedMesh, buildBillboardMesh, rng,
+ type Plant, type Ground, type ScatterParams, type BladeParams, type CardRect,
+} from './builder';
+
+// Importing this subpath INSTALLS foliage — see tilemap/index.ts. It stands on a Terrain when the scene has one and
+// needs none to stand on a flat floor, so it does not pull terrain's plugin in.
+import { registerFoliageSupport } from './foliageSupport';
+
+registerFoliageSupport();
diff --git a/sdk/src/platform/nativeModuleRegistry.ts b/sdk/src/platform/nativeModuleRegistry.ts
index ff135624b..f6c4d9e9c 100644
--- a/sdk/src/platform/nativeModuleRegistry.ts
+++ b/sdk/src/platform/nativeModuleRegistry.ts
@@ -24,6 +24,8 @@ import * as Physics3DModule from '../physics3d';
import * as SpineModule from '../spine';
import * as DragonBonesModule from '../dragonbones';
import * as TilemapModule from '../tilemap';
+import * as TerrainModule from '../terrain';
+import * as FoliageModule from '../foliage';
import * as ScriptGraphModule from '../logic';
import * as AiModule from '../ai';
import * as ReplicationModule from '../net/replication';
@@ -43,6 +45,8 @@ export const NATIVE_MODULE_NAMESPACES: Readonly<Record<string, unknown>> = {
'esengine/spine': SpineModule,
'esengine/dragonbones': DragonBonesModule,
'esengine/tilemap': TilemapModule,
+ 'esengine/terrain': TerrainModule,
+ 'esengine/foliage': FoliageModule,
'esengine/logic': ScriptGraphModule,
'esengine/ai': AiModule,
'esengine/replication': ReplicationModule,
diff --git a/sdk/src/runtime/optionalPlugins.ts b/sdk/src/runtime/optionalPlugins.ts
index 59868f4de..86c8ef5cf 100644
--- a/sdk/src/runtime/optionalPlugins.ts
+++ b/sdk/src/runtime/optionalPlugins.ts
@@ -20,6 +20,8 @@ import { registerDragonBonesSupport } from '../dragonbones/dragonBonesSupport';
import { registerPhysics2DSupport } from '../physics/physicsSupport';
import { registerPhysics3DSupport } from '../physics3d/physics3dSupport';
import { registerTilemapSupport } from '../tilemap/tilemapSupport';
+import { registerTerrainSupport } from '../terrain/terrainSupport';
+import { registerFoliageSupport } from '../foliage/foliageSupport';
import { registerScriptGraphSupport } from '../logic/logicSupport';
import { registerAiSupport } from '../ai/aiSupport';
import { registerReplicationSupport } from '../net/replication/replicationSupport';
@@ -32,6 +34,8 @@ export function installOptionalPlugins(): void {
registerPhysics2DSupport();
registerPhysics3DSupport();
registerTilemapSupport();
+ registerTerrainSupport();
+ registerFoliageSupport();
registerScriptGraphSupport();
registerAiSupport();
registerReplicationSupport();
diff --git a/sdk/src/terrain/index.ts b/sdk/src/terrain/index.ts
new file mode 100644
index 000000000..54c36b359
--- /dev/null
+++ b/sdk/src/terrain/index.ts
@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+export {
+ Terrain, Terrains, TerrainsRes, TerrainPlugin, terrainPlugin, paintWeights, type TerrainData,
+} from './terrainPlugin';
+export {
+ heightfieldFromPixels, proceduralHeightfield, sampleHeight, terrainNormal,
+ type Heightfield, type ProceduralParams,
+} from './heightfield';
+export {
+ buildChunkMesh, cellsAtLod, chunkCenter, lodCount, type TerrainShape, type TerrainPaint,
+} from './mesh';
+
+// Importing this subpath INSTALLS terrain — see tilemap/index.ts.
+import { registerTerrainSupport } from './terrainSupport';
+
+registerTerrainSupport();
diff --git a/sdk/src/terrain/terrainSupport.ts b/sdk/src/terrain/terrainSupport.ts
new file mode 100644
index 000000000..2a99b5cf7
--- /dev/null
+++ b/sdk/src/terrain/terrainSupport.ts
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file terrainSupport.ts — what a build that ships terrain tells the core.
+ *
+ * A call, not a file's side effect — see tilemap/tilemapSupport.ts.
+ */
+import { addEntryPlugin } from '../runtime/entryPlugins';
+import { TerrainPlugin } from './terrainPlugin';
+
+export function registerTerrainSupport(): void {
+ addEntryPlugin('terrain', () => new TerrainPlugin());
+}
diff --git a/tools/lib/sdkProgram.mjs b/tools/lib/sdkProgram.mjs
index bbe848468..8a508529d 100644
--- a/tools/lib/sdkProgram.mjs
+++ b/tools/lib/sdkProgram.mjs
@@ -59,6 +59,8 @@ export const ENTRIES = {
'spine': 'src/spine/index.ts',
'dragonbones': 'src/dragonbones/index.ts',
'tilemap': 'src/tilemap/index.ts',
+ 'terrain': 'src/terrain/index.ts',
+ 'foliage': 'src/foliage/index.ts',
'logic': 'src/logic/index.ts',
'debug-channel': 'src/debug-channel/index.ts',
'ai': 'src/ai/index.ts',
diff --git a/tools/nativeScriptModules.js b/tools/nativeScriptModules.js
index 3b5107c5c..f47669b66 100644
--- a/tools/nativeScriptModules.js
+++ b/tools/nativeScriptModules.js
@@ -65,6 +65,8 @@ export const MODULES = {
'esengine/spine': { disposition: 'native-subpath' },
'esengine/dragonbones': { disposition: 'native-subpath' },
'esengine/tilemap': { disposition: 'native-subpath' },
+ 'esengine/terrain': { disposition: 'native-subpath' },
+ 'esengine/foliage': { disposition: 'native-subpath' },
'esengine/logic': { disposition: 'native-subpath' },
'esengine/ai': { disposition: 'native-subpath' },
'esengine/replication': { disposition: 'native-subpath' },
diff --git a/tools/releaseNotes.mjs b/tools/releaseNotes.mjs
index 4a3cf782e..437d44db4 100644
--- a/tools/releaseNotes.mjs
+++ b/tools/releaseNotes.mjs
@@ -2527,6 +2527,8 @@ export const NOTED = {
{"note":"Particle emitters can now simulate on the GPU: turn on gpuSimulation and a compute kernel advances every particle, so an emitter of a hundred thousand or a million particles costs a dispatch instead of a loop."},
"feat(star-neighbors): add modular art and construction study":
{"internal":"art source and review images of an in-development game under games/, which no creator using the engine or editor can observe"},
+ "feat(sdk): terrain and foliage are optional modules, so a package carries them only when its content does":
+ {"note":"Terrain and Foliage are now optional modules, esengine/terrain and esengine/foliage: a package carries them when a scene has a Terrain or Foliage component or a script imports the subpath, and a game with neither ships none of them (about 33 KB less in a UI-only mini-game)."},
"chore(tools): the gates run in parallel with --jobs, and the reds a full run gathered are cleared":
{"internal":"tooling for the static gates, and fixes to checks that had drifted from the code they guard"},
"fix(render): a wire narrower than a pixel is no longer painted over by the sky in dashes":