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.

refactor(gameplay): the gameplay runtime moves to its own subpath

esenginec396b4529d05
diff --git a/desktop b/desktop
index b93afcdb7..e0aaf324c 160000
--- a/desktop
+++ b/desktop
@@ -1 +1 @@
-Subproject commit b93afcdb7f6bb749a0162e28829a65a7527664ae
+Subproject commit e0aaf324c1efc6ba0200561ab490edb64c4b0f7c
diff --git a/docs/astro/src/data/apiStability.generated.json b/docs/astro/src/data/apiStability.generated.json
index 558b8e109..06aa7fa31 100644
--- a/docs/astro/src/data/apiStability.generated.json
+++ b/docs/astro/src/data/apiStability.generated.json
@@ -3,10 +3,10 @@
"counts": {
"public": 115,
"beta": 103,
- "experimental": 2087,
+ "experimental": 2091,
"deprecated": 3
},
- "total": 2305,
+ "total": 2309,
"subsystems": [
{
"id": "ecs",
diff --git a/examples/third-person-3d/src/main.ts b/examples/third-person-3d/src/main.ts
index 36f90fc63..70fe66611 100644
--- a/examples/third-person-3d/src/main.ts
+++ b/examples/third-person-3d/src/main.ts
@@ -1,10 +1,8 @@
// Movement is declared, not scripted — ThirdPersonController, ThirdPersonCamera
// and Hunter are components the scene carries. What a game DOES own is what an
// animation and a blow MEAN: dust under a footstep, sparks where a sword lands.
-import {
- addSystemToSchedule, Schedule, defineSystem, EventReader, GetWorld, Res,
- AnimatorEvent, Damage, Transform, Particle, resolveChildEntity,
-} from 'esengine';
+import { addSystemToSchedule, Schedule, defineSystem, EventReader, GetWorld, Res, AnimatorEvent, Transform, Particle, resolveChildEntity } from 'esengine';
+import { Damage } from 'esengine/gameplay';
/**
* Dust on a footstep. The animator says WHEN a foot lands — a moment the walk
diff --git a/examples/third-person-3d/src/systems/hud.ts b/examples/third-person-3d/src/systems/hud.ts
index 4e2dc6e82..3a03350c9 100644
--- a/examples/third-person-3d/src/systems/hud.ts
+++ b/examples/third-person-3d/src/systems/hud.ts
@@ -1,7 +1,5 @@
-import {
- defineSystem, Res, ResMut, Query, Mut,
- Text, UIVisual, Health, Playthrough, type PlaythroughData,
-} from 'esengine';
+import { defineSystem, Res, ResMut, Query, Mut, Text, UIVisual, Playthrough, type PlaythroughData } from 'esengine';
+import { Health } from 'esengine/gameplay';
import { Runner, Gate, HealthMeter, ObjectiveText, PromptText, OverlayText } from '../components';
import { Run, MAX_HEALTH, CORES_NEEDED, type RunData } from '../resources';
diff --git a/examples/third-person-3d/src/systems/lifecycle.ts b/examples/third-person-3d/src/systems/lifecycle.ts
index 4fba1f556..a76ddcc70 100644
--- a/examples/third-person-3d/src/systems/lifecycle.ts
+++ b/examples/third-person-3d/src/systems/lifecycle.ts
@@ -1,9 +1,5 @@
-import {
- defineSystem, Res, ResMut, Query, Mut, GetWorld,
- Time, Transform, MeshRenderer, CharacterController3D, Health,
- Damage, restoreToFull, EventWriter,
- type World, type Entity, type TimeData, type HealthData,
-} from 'esengine';
+import { defineSystem, Res, ResMut, Query, Mut, GetWorld, Time, Transform, MeshRenderer, CharacterController3D, EventWriter, type World, type Entity, type TimeData } from 'esengine';
+import { Health, Damage, restoreToFull, type HealthData } from 'esengine/gameplay';
import { Physics3D, type Physics3DQueries } from 'esengine/physics3d';
import { Runner, Core, Gate, Checkpoint } from '../components';
import { Run, SPAWN, VOID_Y, MAX_HEALTH, type RunData } from '../resources';
diff --git a/examples/third-person-3d/src/systems/run.ts b/examples/third-person-3d/src/systems/run.ts
index 33dbd5ae6..1b1d967c1 100644
--- a/examples/third-person-3d/src/systems/run.ts
+++ b/examples/third-person-3d/src/systems/run.ts
@@ -1,8 +1,5 @@
-import {
- defineSystem, Res, ResMut, Query, Mut,
- Input, Time, Transform, ThirdPersonController,
- type InputState, type TimeData,
-} from 'esengine';
+import { defineSystem, Res, ResMut, Query, Mut, Input, Time, Transform, type InputState, type TimeData } from 'esengine';
+import { ThirdPersonController } from 'esengine/gameplay';
import { Runner, Checkpoint } from '../components';
import { Run, SPRINT_SPEED, WALK_SPEED, type RunData } from '../resources';
diff --git a/examples/third-person-3d/src/systems/world.ts b/examples/third-person-3d/src/systems/world.ts
index 0a4eb17bb..7b68b072e 100644
--- a/examples/third-person-3d/src/systems/world.ts
+++ b/examples/third-person-3d/src/systems/world.ts
@@ -1,8 +1,5 @@
-import {
- defineSystem, Res, ResMut, Query, Mut, EventWriter,
- Time, Transform, MeshRenderer, Damage,
- type TimeData, type Entity,
-} from 'esengine';
+import { defineSystem, Res, ResMut, Query, Mut, EventWriter, Time, Transform, MeshRenderer, type TimeData, type Entity } from 'esengine';
+import { Damage } from 'esengine/gameplay';
import { Runner, Hazard, Core, Gate, Reachable } from '../components';
import { Run, CORES_NEEDED, type RunData } from '../resources';
diff --git a/examples/third-person-3d/tsconfig.json b/examples/third-person-3d/tsconfig.json
index 6fecb89b0..a7236e917 100644
--- a/examples/third-person-3d/tsconfig.json
+++ b/examples/third-person-3d/tsconfig.json
@@ -13,7 +13,8 @@
"paths": {
"esengine": ["./.esengine/sdk/index.d.ts"],
"esengine/wasm": ["./.esengine/sdk/wasm.d.ts"],
- "esengine/physics3d": ["./.esengine/sdk/physics3d/index.d.ts"]
+ "esengine/physics3d": ["./.esengine/sdk/physics3d/index.d.ts"],
+ "esengine/gameplay": ["./.esengine/sdk/gameplay/index.d.ts"]
}
},
"include": ["src/**/*"],
diff --git a/examples/world-streaming-3d/src/main.ts b/examples/world-streaming-3d/src/main.ts
index 73c008933..d2ebbc53d 100644
--- a/examples/world-streaming-3d/src/main.ts
+++ b/examples/world-streaming-3d/src/main.ts
@@ -1,11 +1,10 @@
// The gestures a criterion needs and residency must not provide: switching a
// source off, moving one along a boundary, aiming a blow at an entity that is
// gone. Residency itself is declared, and nothing below loads or unloads.
-import {
- addSystemToSchedule, Schedule, defineSystem, GetWorld, Res, EventWriter, Time,
- Input, Damage, Transform, WorldStreamingSource, ParticleEmitter,
-} from 'esengine';
-import type { World, InputState, TimeData, EventWriterInstance, DamagePayload } from 'esengine';
+import { addSystemToSchedule, Schedule, defineSystem, GetWorld, Res, EventWriter, Time, Input, Transform, WorldStreamingSource, ParticleEmitter } from 'esengine';
+import { Damage } from 'esengine/gameplay';
+import type { World, InputState, TimeData, EventWriterInstance } from 'esengine';
+import type { DamagePayload } from 'esengine/gameplay';
/** Flip a named source on or off. The only thing that changes is who is asking. */
function toggleSource(world: World, name: string): void {
diff --git a/examples/world-streaming-3d/tsconfig.json b/examples/world-streaming-3d/tsconfig.json
index 1f11ff310..496383648 100644
--- a/examples/world-streaming-3d/tsconfig.json
+++ b/examples/world-streaming-3d/tsconfig.json
@@ -12,7 +12,8 @@
"rootDir": ".",
"paths": {
"esengine": ["./.esengine/sdk/index.d.ts"],
- "esengine/wasm": ["./.esengine/sdk/wasm.d.ts"]
+ "esengine/wasm": ["./.esengine/sdk/wasm.d.ts"],
+ "esengine/gameplay": ["./.esengine/sdk/gameplay/index.d.ts"]
}
},
"include": ["src/**/*"],
diff --git a/pipeline/src/bundle/esengineResolve.ts b/pipeline/src/bundle/esengineResolve.ts
index 756c7ce87..9b21e14c7 100644
--- a/pipeline/src/bundle/esengineResolve.ts
+++ b/pipeline/src/bundle/esengineResolve.ts
@@ -28,6 +28,7 @@ export const ESENGINE_SUBPATHS: Readonly<Record<string, string>> = {
'esengine/logic': 'logic/index.js',
'esengine/ai': 'ai/index.js',
'esengine/replication': 'net/replication/index.js',
+ 'esengine/gameplay': 'gameplay/index.js',
'esengine/dragonbones': 'dragonbones/index.js',
'esengine/physics': 'physics/index.js',
'esengine/physics3d': 'physics3d/index.js',
diff --git a/pipeline/src/project/targetSupport.ts b/pipeline/src/project/targetSupport.ts
index 8188fb9f7..84c00f050 100644
--- a/pipeline/src/project/targetSupport.ts
+++ b/pipeline/src/project/targetSupport.ts
@@ -26,7 +26,7 @@
import { NATIVE_PLATFORMS, type ExportPlatform } from './platforms';
/** An engine subsystem a build target may lack. */
-export type Subsystem = 'text' | 'tilemap' | 'particles' | 'postprocess' | 'physics' | 'spine' | 'video' | 'ai' | 'replication';
+export type Subsystem = 'text' | 'tilemap' | 'particles' | 'postprocess' | 'physics' | 'spine' | 'video' | 'ai' | 'replication' | 'gameplay';
/**
* The authored vocabulary that puts a subsystem in use: a scene or prefab
@@ -51,6 +51,9 @@ export const SUBSYSTEM_COMPONENTS: Readonly<Record<Subsystem, readonly string[]>
'Perceiver', 'Perception', 'StateMachineAgent', 'BehaviorTreeAgent',
],
replication: ['Replicated', 'NetGhost'],
+ gameplay: [
+ 'ThirdPersonController', 'ThirdPersonCamera', 'Health', 'MeleeAttack', 'Hunter', 'Playthrough',
+ ],
};
/** Human name, for a message someone packaging a game has to act on. */
@@ -64,6 +67,7 @@ export const SUBSYSTEM_LABEL: Readonly<Record<Subsystem, string>> = {
video: 'Video',
ai: 'Gameplay AI',
replication: 'Replication',
+ gameplay: 'Gameplay (character, combat)',
};
/**
@@ -82,6 +86,7 @@ export const SUBSYSTEM_INSTALL: Readonly<Record<Subsystem, string>> = {
video: 'whole-entry',
ai: 'esengine/ai',
replication: 'esengine/replication',
+ gameplay: 'esengine/gameplay',
};
/**
diff --git a/pipeline/src/runtime/gameHost.ts b/pipeline/src/runtime/gameHost.ts
index 35f523f45..911bc0231 100644
--- a/pipeline/src/runtime/gameHost.ts
+++ b/pipeline/src/runtime/gameHost.ts
@@ -16,8 +16,8 @@ import {
indexPackagedManifest, createPackagedAssetSource, applyAssetRefResolvers, initRuntime,
HttpBackend, fetchDecodePixels, registerPackagedSideModules,
packagedAppOptions, packagedRuntimeInit, Transform, SceneManager, UINode,
- acquireWebGPUDevice, ThirdPersonCamera, CharacterController3D, AnimatorController,
- Animator, TPC_SPEED, TPC_GROUNDED, Particle, MeleeAttack, Health,
+ acquireWebGPUDevice, CharacterController3D, AnimatorController,
+ Animator, TPC_SPEED, TPC_GROUNDED, Particle,
AnimatorRootMotion, Playthrough, Name,
worldResidencyReport, PostProcess, Renderer, Audio, Camera,
getComponentRegistry,
@@ -40,6 +40,13 @@ function countOfIn(app: { world: { getEntitiesWithComponents(c: never[]): readon
return def === null ? 0 : app.world.getEntitiesWithComponents([def]).length;
}
+/** Entities carrying a component the package may not ship at all. */
+function optionalEntities(app: { world: { getEntitiesWithComponents(c: never[]): readonly number[] } },
+ name: string): readonly number[] {
+ const def = optionalDef(name);
+ return def === null ? [] : app.world.getEntitiesWithComponents([def]);
+}
+
function optionalRead(app: { world: { has(e: number, c: never): boolean; get(e: number, c: never): unknown } },
entity: number, name: string): Record<string, never> | null {
const def = optionalDef(name);
@@ -366,9 +373,8 @@ async function boot(): Promise<void> {
for (const e of app.world.getEntitiesWithComponents([Name])) {
const n = app.world.get(e, Name).value;
if (named.length < limit) named.push(n);
- if (app.world.has(e, Health) && alive.length < limit) {
- alive.push({ name: n, hp: app.world.get(e, Health).current });
- }
+ const hp = optionalRead(app, e, 'Health');
+ if (hp !== null && alive.length < limit) alive.push({ name: n, hp: hp.current as never });
}
return { entities: app.world.getAllEntities().length, named, alive };
},
@@ -435,8 +441,8 @@ async function boot(): Promise<void> {
? { x: root.deltaPosition.x / root.deltaTime, z: root.deltaPosition.z / root.deltaTime }
: null,
position: p ? { x: p.x, y: p.y, z: p.z ?? 0 } : null,
- attackId: app.world.has(enemy, MeleeAttack) ? app.world.get(enemy, MeleeAttack).attackId : 0,
- health: app.world.has(enemy, Health) ? app.world.get(enemy, Health).current : 0,
+ attackId: optionalRead(app, enemy, 'MeleeAttack')?.attackId ?? 0,
+ health: optionalRead(app, enemy, 'Health')?.current ?? 0,
};
},
/**
@@ -452,15 +458,13 @@ async function boot(): Promise<void> {
const targets: Record<string, { health: number; max: number }> = {};
for (const name of targetNames) {
const entity = app.world.findEntityByName(name);
- if (entity === null || !app.world.has(entity, Health)) continue;
- const health = app.world.get(entity, Health);
- targets[name] = { health: health.current, max: health.max };
+ const health = entity === null ? null : optionalRead(app, entity, 'Health');
+ if (health === null) continue;
+ targets[name] = { health: health.current as never, max: health.max as never };
}
const attacker = app.world.findEntityByName(attackerName);
- if (attacker === null || !app.world.has(attacker, MeleeAttack)) {
- return { attack: null, targets };
- }
- const melee = app.world.get(attacker, MeleeAttack);
+ const melee = attacker === null ? null : optionalRead(app, attacker, 'MeleeAttack');
+ if (attacker === null || melee === null) return { attack: null, targets };
return {
attack: {
id: melee.attackId,
@@ -538,7 +542,7 @@ async function boot(): Promise<void> {
let camera = null;
let cameraDistance = null;
const eye = cameraName ? app.world.findEntityByName(cameraName)
- : (app.world.getEntitiesWithComponents([ThirdPersonCamera])[0] ?? null);
+ : (optionalEntities(app, 'ThirdPersonCamera')[0] ?? null);
if (eye !== null && eye !== undefined && app.world.has(eye, Transform)) {
const ct = app.world.get(eye, Transform);
const cp = ct.worldPosition ?? ct.position;
diff --git a/sdk/etc/gameplay.api.md b/sdk/etc/gameplay.api.md
new file mode 100644
index 000000000..e026fd6be
--- /dev/null
+++ b/sdk/etc/gameplay.api.md
@@ -0,0 +1,309 @@
+# API surface — esengine/gameplay
+
+<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
+Symbols: 0 public · 0 beta · 50 experimental · 0 deprecated
+
+## ATTACK_KEY — const @experimental
+```
+"KeyJ"
+```
+
+## COMBAT_ATTACK_END — const @experimental
+```
+"attack-end"
+```
+
+## COMBAT_ATTACK_START — const @experimental
+```
+"attack-start"
+```
+
+## COMBAT_HIT — const @experimental
+```
+"hit"
+```
+
+## DODGE_KEY — const @experimental
+```
+"ShiftLeft"
+```
+
+## Damage — const @experimental
+```
+EventDef<DamagePayload>
+```
+
+## DamagePayload — interface @experimental
+```
+amount: number
+source: number
+target: number
+x: number
+y: number
+z: number
+```
+
+## GameplayPlugin — class @experimental
+```
+build: (app: App) => void
+cleanup: () => void
+name: string
+static new (): GameplayPlugin
+static prototype: GameplayPlugin
+```
+
+## Health — const @experimental
+```
+ComponentDef<HealthData>
+```
+
+## HealthData — interface @experimental
+```
+current: number
+max: number
+```
+
+## Hunter — const @experimental
+```
+ComponentDef<HunterData>
+```
+
+## HunterData — interface @experimental
+```
+attackInterval: number
+attackRange: number
+cooldown: number
+enabled: boolean
+idleThreshold: number
+rotationSpeed: number
+state: string
+```
+
+## HunterSituation — interface @experimental
+```
+alive: boolean
+attackRange: number
+distance: number
+visible: boolean
+```
+
+## HunterState — type @experimental
+```
+'idle' | 'chase' | 'attack' | 'dead'
+```
+
+## MeleeAttack — const @experimental
+```
+ComponentDef<MeleeAttackData>
+```
+
+## MeleeAttackData — interface @experimental
+```
+anchor: number
+attackId: number
+damage: number
+enabled: boolean
+hitCount: number
+layers: number
+radius: number
+```
+
+## MeleeAttacks — class @experimental
+```
+clear: () => void
+close: (entity: Entity) => void
+forget: (entity: Entity) => void
+live: (entity: Entity) => { id: number; hits: number; } | null
+open: (entity: Entity) => number
+record: (entity: Entity, target: Entity) => boolean
+static new (): MeleeAttacks
+static prototype: MeleeAttacks
+```
+
+## MeleeOverlapQuery — interface @experimental
+```
+overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
+```
+
+## MoveBasis — interface @experimental
+```
+forward: Vec3
+right: Vec3
+```
+
+## TPC_ATTACK — const @experimental
+```
+"attack"
+```
+
+## TPC_DODGE — const @experimental
+```
+"dodge"
+```
+
+## TPC_GROUNDED — const @experimental
+```
+"grounded"
+```
+
+## TPC_JUMP — const @experimental
+```
+"jump"
+```
+
+## TPC_SPEED — const @experimental
+```
+"speed"
+```
+
+## ThirdPersonCamera — const @experimental
+```
+ComponentDef<ThirdPersonCameraData>
+```
+
+## ThirdPersonCameraData — interface @experimental
+```
+distance: number
+enabled: boolean
+followDamping: number
+maxPitch: number
+minPitch: number
+obstruction: boolean
+obstructionLayers: number
+obstructionRadius: number
+pitch: number
+sensitivity: number
+target: number
+targetOffset: Vec3
+yaw: number
+```
+
+## ThirdPersonController — const @experimental
+```
+ComponentDef<ThirdPersonControllerData>
+```
+
+## ThirdPersonControllerData — interface @experimental
+```
+acceleration: number
+airControl: number
+camera: number
+cameraRelative: boolean
+deceleration: number
+enabled: boolean
+idleThreshold: number
+jumpSpeed: number
+moveSpeed: number
+rotationSpeed: number
+```
+
+## WORLD_BASIS — const @experimental
+```
+MoveBasis
+```
+
+## applyDamage — function @experimental
+```
+(world: World, blows: Iterable<DamagePayload>): void
+```
+
+## approachVelocity — function @experimental
+```
+(current: { x: number; z: number; }, target: { x: number; z: number; }, acceleration: number, deceleration: number, dt: number): { x: number; z: number; }
+```
+
+## cameraGroundBasis — function @experimental
+```
+(yawDeg: number): { forward: Vec3; right: Vec3; }
+```
+
+## clampPitch — function @experimental
+```
+(pitch: number, min: number, max: number): number
+```
+
+## dampFactor — function @experimental
+```
+(damping: number, dt: number): number
+```
+
+## decideHunterState — function @experimental
+```
+(s: HunterSituation): HunterState
+```
+
+## desiredDirection — function @experimental
+```
+(input: { x: number; y: number; }, basis: MoveBasis): Vec3
+```
+
+## facingYaw — function @experimental
+```
+(direction: Vec3): number
+```
+
+## gameplayPlugin — const @experimental
+```
+GameplayPlugin
+```
+
+## huntTargets — function @experimental
+```
+(world: World, animator: AnimatorControllerAPI | null, attackTrigger: string, dt: number): void
+```
+
+## observeMotion — function @experimental
+```
+(world: World, animator: AnimatorControllerAPI | null, dt: number): void
+```
+
+## orbitOffset — function @experimental
+```
+(yawDeg: number, pitchDeg: number): Vec3
+```
+
+## requestMotion — function @experimental
+```
+(world: World, input: InputState, dt: number, animator?: AnimatorControllerAPI | null): void
+```
+
+## resolveMeleeHits — function @experimental
+```
+(world: World, attacks: MeleeAttacks, queries: MeleeOverlapQuery | null, events: Iterable<AnimatorEventPayload>, damage: { send(blow: DamagePayload): void; }): void
+```
+
+## restoreToFull — function @experimental
+```
+(world: World, entity: Entity): void
+```
+
+## rootMotionVelocity — function @experimental
+```
+(delta: { x: number; z: number; }, seconds: number): { x: number; z: number; }
+```
+
+## shortestAngleDelta — function @experimental
+```
+(from: number, to: number): number
+```
+
+## turnToward — function @experimental
+```
+(from: number, to: number, degreesPerSecond: number, dt: number): number
+```
+
+## updateCameras — function @experimental
+```
+(world: World, input: InputState, queries: Physics3DQueries | null, dt: number): void
+```
+
+## yawOfQuaternion — function @experimental
+```
+(q: { w: number; y: number; }): number
+```
+
+## yawQuaternion — function @experimental
+```
+(yawDeg: number): { w: number; x: number; y: number; z: number; }
+```
+
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 9d11dca82..ce8907ce0 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 · 91 beta · 1513 experimental · 3 deprecated
+Symbols: 115 public · 91 beta · 1477 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -2657,21 +2657,6 @@ ScreenScalingData
"unattributed"
```
-## Damage — const @experimental
-```
-EventDef<DamagePayload>
-```
-
-## DamagePayload — interface @experimental
-```
-amount: number
-source: number
-target: number
-x: number
-y: number
-z: number
-```
-
## DataSource — interface @experimental
```
getCount: () => number
@@ -3803,15 +3788,6 @@ index: number
mapping: string
```
-## GameplayPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: () => void
-name: string
-static new (): GameplayPlugin
-static prototype: GameplayPlugin
-```
-
## GearBinding — interface @experimental
```
component: string
@@ -3966,17 +3942,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Health — const @experimental
-```
-ComponentDef<HealthData>
-```
-
-## HealthData — interface @experimental
-```
-current: number
-max: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -4020,35 +3985,6 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## Hunter — const @experimental
-```
-ComponentDef<HunterData>
-```
-
-## HunterData — interface @experimental
-```
-attackInterval: number
-attackRange: number
-cooldown: number
-enabled: boolean
-idleThreshold: number
-rotationSpeed: number
-state: string
-```
-
-## HunterSituation — interface @experimental
-```
-alive: boolean
-attackRange: number
-distance: number
-visible: boolean
-```
-
-## HunterState — type @experimental
-```
-'idle' | 'chase' | 'attack' | 'dead'
-```
-
## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
@@ -4911,39 +4847,6 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MeleeAttack — const @experimental
-```
-ComponentDef<MeleeAttackData>
-```
-
-## MeleeAttackData — interface @experimental
-```
-anchor: number
-attackId: number
-damage: number
-enabled: boolean
-hitCount: number
-layers: number
-radius: number
-```
-
-## MeleeAttacks — class @experimental
-```
-clear: () => void
-close: (entity: Entity) => void
-forget: (entity: Entity) => void
-live: (entity: Entity) => { id: number; hits: number; } | null
-open: (entity: Entity) => number
-record: (entity: Entity, target: Entity) => boolean
-static new (): MeleeAttacks
-static prototype: MeleeAttacks
-```
-
-## MeleeOverlapQuery — interface @experimental
-```
-overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
-```
-
## MeshChannel — const @experimental
```
{ readonly Position: 0; readonly Color: 1; readonly TexCoord0: 2; readonly Normal: 3; readonly Tangent: 4; readonly Joints: 5; readonly Weights: 6; readonly TexCoord1: 7; }
@@ -5168,12 +5071,6 @@ ComponentDef<MotorJoint2DData>
(button: number) => Binding
```
-## MoveBasis — interface @experimental
-```
-forward: Vec3
-right: Vec3
-```
-
## Mut — function @public
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
@@ -8126,6 +8023,11 @@ readonly (keyof ThemeColors)[]
"grounded"
```
+## TPC_JUMP — const @experimental
+```
+"jump"
+```
+
## TPC_SPEED — const @experimental
```
"speed"
@@ -8437,47 +8339,6 @@ label: number
title: number
```
-## ThirdPersonCamera — const @experimental
-```
-ComponentDef<ThirdPersonCameraData>
-```
-
-## ThirdPersonCameraData — interface @experimental
-```
-distance: number
-enabled: boolean
-followDamping: number
-maxPitch: number
-minPitch: number
-obstruction: boolean
-obstructionLayers: number
-obstructionRadius: number
-pitch: number
-sensitivity: number
-target: number
-targetOffset: Vec3
-yaw: number
-```
-
-## ThirdPersonController — const @experimental
-```
-ComponentDef<ThirdPersonControllerData>
-```
-
-## ThirdPersonControllerData — interface @experimental
-```
-acceleration: number
-airControl: number
-camera: number
-cameraRelative: boolean
-deceleration: number
-enabled: boolean
-idleThreshold: number
-jumpSpeed: number
-moveSpeed: number
-rotationSpeed: number
-```
-
## Time — const @public
```
ResourceDef<TimeData>
@@ -9399,11 +9260,6 @@ y: number
(id: string) => Binding
```
-## WORLD_BASIS — const @experimental
-```
-MoveBasis
-```
-
## WORLD_DIR — const @experimental
```
"world"
@@ -9904,11 +9760,6 @@ AnimationPlugin
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDamage — function @experimental
-```
-(world: World, blows: Iterable<DamagePayload>): void
-```
-
## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
@@ -9934,11 +9785,6 @@ AnimationPlugin
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## approachVelocity — function @experimental
-```
-(current: { x: number; z: number; }, target: { x: number; z: number; }, acceleration: number, deceleration: number, dt: number): { x: number; z: number; }
-```
-
## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
@@ -10099,11 +9945,6 @@ MotionDriver<AnimatorBlend2DMotion>
(camera: CameraFields, transform: CameraTransformFields, width: number, height: number, canvas: CanvasScale | null, result?: Float32Array): Float32Array
```
-## cameraGroundBasis — function @experimental
-```
-(yawDeg: number): { forward: Vec3; right: Vec3; }
-```
-
## canCaptureFramePixels — function @experimental
```
(module: ESEngineModule): boolean
@@ -10144,11 +9985,6 @@ MotionDriver<AnimatorBlend2DMotion>
(): string[]
```
-## clampPitch — function @experimental
-```
-(pitch: number, min: number, max: number): number
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -10444,21 +10280,11 @@ Plugin
(scene: SceneData, sceneName: string, options: PartitionOptions): CutWorld | null
```
-## dampFactor — function @experimental
-```
-(damping: number, dt: number): number
-```
-
## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decideHunterState — function @experimental
-```
-(s: HunterSituation): HunterState
-```
-
## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
@@ -10534,11 +10360,6 @@ PluralSelector
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## desiredDirection — function @experimental
-```
-(input: { x: number; y: number; }, basis: MoveBasis): Vec3
-```
-
## desiredResidency — function @experimental
```
(cells: readonly WorldCell[], sources: readonly ResidencySource[], resident: ReadonlySet<string>): ResidencyDecision
@@ -10809,11 +10630,6 @@ EventBindingPlugin
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingYaw — function @experimental
-```
-(direction: Vec3): number
-```
-
## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
@@ -10889,11 +10705,6 @@ FocusPlugin
(): boolean
```
-## gameplayPlugin — const @experimental
-```
-GameplayPlugin
-```
-
## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
@@ -11089,11 +10900,6 @@ GameplayPlugin
() => Plugin[]
```
-## huntTargets — function @experimental
-```
-(world: World, animator: AnimatorControllerAPI | null, attackTrigger: string, dt: number): void
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -11499,11 +11305,6 @@ MeshRendererPlugin
(world: World, events: UIEventQueue, e: Entity): void
```
-## orbitOffset — function @experimental
-```
-(yawDeg: number, pitchDeg: number): Vec3
-```
-
## overlayPose — function @experimental
```
(acc: Pose, layer: Pose, weight: number, world: PoseWorld, reach: LayerReach | null): void
@@ -12004,11 +11805,6 @@ PrefabsPlugin
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveMeleeHits — function @experimental
-```
-(world: World, attacks: MeleeAttacks, queries: MeleeOverlapQuery | null, events: Iterable<AnimatorEventPayload>, damage: { send(blow: DamagePayload): void; }): void
-```
-
## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
@@ -12024,16 +11820,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## restoreToFull — function @experimental
-```
-(world: World, entity: Entity): void
-```
-
-## rootMotionVelocity — function @experimental
-```
-(delta: { x: number; z: number; }, seconds: number): { x: number; z: number; }
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -12354,11 +12140,6 @@ ServicesPlugin
(): string[]
```
-## shortestAngleDelta — function @experimental
-```
-(from: number, to: number): number
-```
-
## shutdownDrawAPI — function @experimental
```
(): void
@@ -12534,11 +12315,6 @@ TrailPlugin
(): number
```
-## turnToward — function @experimental
-```
-(from: number, to: number, degreesPerSecond: number, dt: number): number
-```
-
## uiHitTestWorld — function @experimental
```
(world: PickableWorld, ray: WorldRay, screenRay?: WorldRay): Entity | null
@@ -12769,13 +12545,3 @@ SystemDef
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
-## yawOfQuaternion — function @experimental
-```
-(q: { w: number; y: number; }): number
-```
-
-## yawQuaternion — function @experimental
-```
-(yawDeg: number): { w: number; x: number; y: number; z: number; }
-```
-
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index f74c166f8..58fe3cfd2 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 · 96 beta · 1532 experimental · 3 deprecated
+Symbols: 115 public · 96 beta · 1496 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -2665,21 +2665,6 @@ ScreenScalingData
"unattributed"
```
-## Damage — const @experimental
-```
-EventDef<DamagePayload>
-```
-
-## DamagePayload — interface @experimental
-```
-amount: number
-source: number
-target: number
-x: number
-y: number
-z: number
-```
-
## DataSource — interface @experimental
```
getCount: () => number
@@ -3811,15 +3796,6 @@ index: number
mapping: string
```
-## GameplayPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: () => void
-name: string
-static new (): GameplayPlugin
-static prototype: GameplayPlugin
-```
-
## GearBinding — interface @experimental
```
component: string
@@ -3974,17 +3950,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Health — const @experimental
-```
-ComponentDef<HealthData>
-```
-
-## HealthData — interface @experimental
-```
-current: number
-max: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -4028,35 +3993,6 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## Hunter — const @experimental
-```
-ComponentDef<HunterData>
-```
-
-## HunterData — interface @experimental
-```
-attackInterval: number
-attackRange: number
-cooldown: number
-enabled: boolean
-idleThreshold: number
-rotationSpeed: number
-state: string
-```
-
-## HunterSituation — interface @experimental
-```
-alive: boolean
-attackRange: number
-distance: number
-visible: boolean
-```
-
-## HunterState — type @experimental
-```
-'idle' | 'chase' | 'attack' | 'dead'
-```
-
## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
@@ -4919,39 +4855,6 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MeleeAttack — const @experimental
-```
-ComponentDef<MeleeAttackData>
-```
-
-## MeleeAttackData — interface @experimental
-```
-anchor: number
-attackId: number
-damage: number
-enabled: boolean
-hitCount: number
-layers: number
-radius: number
-```
-
-## MeleeAttacks — class @experimental
-```
-clear: () => void
-close: (entity: Entity) => void
-forget: (entity: Entity) => void
-live: (entity: Entity) => { id: number; hits: number; } | null
-open: (entity: Entity) => number
-record: (entity: Entity, target: Entity) => boolean
-static new (): MeleeAttacks
-static prototype: MeleeAttacks
-```
-
-## MeleeOverlapQuery — interface @experimental
-```
-overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
-```
-
## MemoryProvider — interface @experimental
```
resolveComponentHeap: (cppName: string) => ComponentHeapResolver | null
@@ -5181,12 +5084,6 @@ ComponentDef<MotorJoint2DData>
(button: number) => Binding
```
-## MoveBasis — interface @experimental
-```
-forward: Vec3
-right: Vec3
-```
-
## Mut — function @public
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
@@ -8319,6 +8216,11 @@ readonly (keyof ThemeColors)[]
"grounded"
```
+## TPC_JUMP — const @experimental
+```
+"jump"
+```
+
## TPC_SPEED — const @experimental
```
"speed"
@@ -8630,47 +8532,6 @@ label: number
title: number
```
-## ThirdPersonCamera — const @experimental
-```
-ComponentDef<ThirdPersonCameraData>
-```
-
-## ThirdPersonCameraData — interface @experimental
-```
-distance: number
-enabled: boolean
-followDamping: number
-maxPitch: number
-minPitch: number
-obstruction: boolean
-obstructionLayers: number
-obstructionRadius: number
-pitch: number
-sensitivity: number
-target: number
-targetOffset: Vec3
-yaw: number
-```
-
-## ThirdPersonController — const @experimental
-```
-ComponentDef<ThirdPersonControllerData>
-```
-
-## ThirdPersonControllerData — interface @experimental
-```
-acceleration: number
-airControl: number
-camera: number
-cameraRelative: boolean
-deceleration: number
-enabled: boolean
-idleThreshold: number
-jumpSpeed: number
-moveSpeed: number
-rotationSpeed: number
-```
-
## Time — const @public
```
ResourceDef<TimeData>
@@ -9592,11 +9453,6 @@ y: number
(id: string) => Binding
```
-## WORLD_BASIS — const @experimental
-```
-MoveBasis
-```
-
## WORLD_DIR — const @experimental
```
"world"
@@ -10097,11 +9953,6 @@ AnimationPlugin
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDamage — function @experimental
-```
-(world: World, blows: Iterable<DamagePayload>): void
-```
-
## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
@@ -10127,11 +9978,6 @@ AnimationPlugin
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## approachVelocity — function @experimental
-```
-(current: { x: number; z: number; }, target: { x: number; z: number; }, acceleration: number, deceleration: number, dt: number): { x: number; z: number; }
-```
-
## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
@@ -10307,11 +10153,6 @@ MotionDriver<AnimatorBlend2DMotion>
(camera: CameraFields, transform: CameraTransformFields, width: number, height: number, canvas: CanvasScale | null, result?: Float32Array): Float32Array
```
-## cameraGroundBasis — function @experimental
-```
-(yawDeg: number): { forward: Vec3; right: Vec3; }
-```
-
## canCaptureFramePixels — function @experimental
```
(module: ESEngineModule): boolean
@@ -10352,11 +10193,6 @@ MotionDriver<AnimatorBlend2DMotion>
(): string[]
```
-## clampPitch — function @experimental
-```
-(pitch: number, min: number, max: number): number
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -10677,21 +10513,11 @@ Plugin
(scene: SceneData, sceneName: string, options: PartitionOptions): CutWorld | null
```
-## dampFactor — function @experimental
-```
-(damping: number, dt: number): number
-```
-
## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decideHunterState — function @experimental
-```
-(s: HunterSituation): HunterState
-```
-
## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
@@ -10767,11 +10593,6 @@ PluralSelector
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## desiredDirection — function @experimental
-```
-(input: { x: number; y: number; }, basis: MoveBasis): Vec3
-```
-
## desiredResidency — function @experimental
```
(cells: readonly WorldCell[], sources: readonly ResidencySource[], resident: ReadonlySet<string>): ResidencyDecision
@@ -11042,11 +10863,6 @@ EventBindingPlugin
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingYaw — function @experimental
-```
-(direction: Vec3): number
-```
-
## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
@@ -11122,11 +10938,6 @@ FocusPlugin
(): boolean
```
-## gameplayPlugin — const @experimental
-```
-GameplayPlugin
-```
-
## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
@@ -11322,11 +11133,6 @@ GameplayPlugin
() => Plugin[]
```
-## huntTargets — function @experimental
-```
-(world: World, animator: AnimatorControllerAPI | null, attackTrigger: string, dt: number): void
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -11742,11 +11548,6 @@ MeshRendererPlugin
(world: World, events: UIEventQueue, e: Entity): void
```
-## orbitOffset — function @experimental
-```
-(yawDeg: number, pitchDeg: number): Vec3
-```
-
## overlayPose — function @experimental
```
(acc: Pose, layer: Pose, weight: number, world: PoseWorld, reach: LayerReach | null): void
@@ -12247,11 +12048,6 @@ PrefabsPlugin
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveMeleeHits — function @experimental
-```
-(world: World, attacks: MeleeAttacks, queries: MeleeOverlapQuery | null, events: Iterable<AnimatorEventPayload>, damage: { send(blow: DamagePayload): void; }): void
-```
-
## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
@@ -12267,16 +12063,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## restoreToFull — function @experimental
-```
-(world: World, entity: Entity): void
-```
-
-## rootMotionVelocity — function @experimental
-```
-(delta: { x: number; z: number; }, seconds: number): { x: number; z: number; }
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -12597,11 +12383,6 @@ ServicesPlugin
(): string[]
```
-## shortestAngleDelta — function @experimental
-```
-(from: number, to: number): number
-```
-
## shutdownDrawAPI — function @experimental
```
(): void
@@ -12777,11 +12558,6 @@ TrailPlugin
(): number
```
-## turnToward — function @experimental
-```
-(from: number, to: number, degreesPerSecond: number, dt: number): number
-```
-
## uiHitTestWorld — function @experimental
```
(world: PickableWorld, ray: WorldRay, screenRay?: WorldRay): Entity | null
@@ -13012,13 +12788,3 @@ SystemDef
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
-## yawOfQuaternion — function @experimental
-```
-(q: { w: number; y: number; }): number
-```
-
-## yawQuaternion — function @experimental
-```
-(yawDeg: number): { w: number; x: number; y: number; z: number; }
-```
-
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index a256a33b8..ba6028d70 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 · 93 beta · 1512 experimental · 3 deprecated
+Symbols: 115 public · 93 beta · 1476 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -2652,21 +2652,6 @@ ScreenScalingData
"unattributed"
```
-## Damage — const @experimental
-```
-EventDef<DamagePayload>
-```
-
-## DamagePayload — interface @experimental
-```
-amount: number
-source: number
-target: number
-x: number
-y: number
-z: number
-```
-
## DataSource — interface @experimental
```
getCount: () => number
@@ -3798,15 +3783,6 @@ index: number
mapping: string
```
-## GameplayPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: () => void
-name: string
-static new (): GameplayPlugin
-static prototype: GameplayPlugin
-```
-
## GearBinding — interface @experimental
```
component: string
@@ -3961,17 +3937,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Health — const @experimental
-```
-ComponentDef<HealthData>
-```
-
-## HealthData — interface @experimental
-```
-current: number
-max: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -4015,35 +3980,6 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## Hunter — const @experimental
-```
-ComponentDef<HunterData>
-```
-
-## HunterData — interface @experimental
-```
-attackInterval: number
-attackRange: number
-cooldown: number
-enabled: boolean
-idleThreshold: number
-rotationSpeed: number
-state: string
-```
-
-## HunterSituation — interface @experimental
-```
-alive: boolean
-attackRange: number
-distance: number
-visible: boolean
-```
-
-## HunterState — type @experimental
-```
-'idle' | 'chase' | 'attack' | 'dead'
-```
-
## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
@@ -4906,39 +4842,6 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MeleeAttack — const @experimental
-```
-ComponentDef<MeleeAttackData>
-```
-
-## MeleeAttackData — interface @experimental
-```
-anchor: number
-attackId: number
-damage: number
-enabled: boolean
-hitCount: number
-layers: number
-radius: number
-```
-
-## MeleeAttacks — class @experimental
-```
-clear: () => void
-close: (entity: Entity) => void
-forget: (entity: Entity) => void
-live: (entity: Entity) => { id: number; hits: number; } | null
-open: (entity: Entity) => number
-record: (entity: Entity, target: Entity) => boolean
-static new (): MeleeAttacks
-static prototype: MeleeAttacks
-```
-
-## MeleeOverlapQuery — interface @experimental
-```
-overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
-```
-
## MeshChannel — const @experimental
```
{ readonly Position: 0; readonly Color: 1; readonly TexCoord0: 2; readonly Normal: 3; readonly Tangent: 4; readonly Joints: 5; readonly Weights: 6; readonly TexCoord1: 7; }
@@ -5163,12 +5066,6 @@ ComponentDef<MotorJoint2DData>
(button: number) => Binding
```
-## MoveBasis — interface @experimental
-```
-forward: Vec3
-right: Vec3
-```
-
## Mut — function @public
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
@@ -8121,6 +8018,11 @@ readonly (keyof ThemeColors)[]
"grounded"
```
+## TPC_JUMP — const @experimental
+```
+"jump"
+```
+
## TPC_SPEED — const @experimental
```
"speed"
@@ -8432,47 +8334,6 @@ label: number
title: number
```
-## ThirdPersonCamera — const @experimental
-```
-ComponentDef<ThirdPersonCameraData>
-```
-
-## ThirdPersonCameraData — interface @experimental
-```
-distance: number
-enabled: boolean
-followDamping: number
-maxPitch: number
-minPitch: number
-obstruction: boolean
-obstructionLayers: number
-obstructionRadius: number
-pitch: number
-sensitivity: number
-target: number
-targetOffset: Vec3
-yaw: number
-```
-
-## ThirdPersonController — const @experimental
-```
-ComponentDef<ThirdPersonControllerData>
-```
-
-## ThirdPersonControllerData — interface @experimental
-```
-acceleration: number
-airControl: number
-camera: number
-cameraRelative: boolean
-deceleration: number
-enabled: boolean
-idleThreshold: number
-jumpSpeed: number
-moveSpeed: number
-rotationSpeed: number
-```
-
## Time — const @public
```
ResourceDef<TimeData>
@@ -9394,11 +9255,6 @@ y: number
(id: string) => Binding
```
-## WORLD_BASIS — const @experimental
-```
-MoveBasis
-```
-
## WORLD_DIR — const @experimental
```
"world"
@@ -9899,11 +9755,6 @@ AnimationPlugin
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDamage — function @experimental
-```
-(world: World, blows: Iterable<DamagePayload>): void
-```
-
## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
@@ -9929,11 +9780,6 @@ AnimationPlugin
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## approachVelocity — function @experimental
-```
-(current: { x: number; z: number; }, target: { x: number; z: number; }, acceleration: number, deceleration: number, dt: number): { x: number; z: number; }
-```
-
## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
@@ -10094,11 +9940,6 @@ MotionDriver<AnimatorBlend2DMotion>
(camera: CameraFields, transform: CameraTransformFields, width: number, height: number, canvas: CanvasScale | null, result?: Float32Array): Float32Array
```
-## cameraGroundBasis — function @experimental
-```
-(yawDeg: number): { forward: Vec3; right: Vec3; }
-```
-
## canCaptureFramePixels — function @experimental
```
(module: ESEngineModule): boolean
@@ -10139,11 +9980,6 @@ MotionDriver<AnimatorBlend2DMotion>
(): string[]
```
-## clampPitch — function @experimental
-```
-(pitch: number, min: number, max: number): number
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -10439,21 +10275,11 @@ Plugin
(scene: SceneData, sceneName: string, options: PartitionOptions): CutWorld | null
```
-## dampFactor — function @experimental
-```
-(damping: number, dt: number): number
-```
-
## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decideHunterState — function @experimental
-```
-(s: HunterSituation): HunterState
-```
-
## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
@@ -10529,11 +10355,6 @@ PluralSelector
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## desiredDirection — function @experimental
-```
-(input: { x: number; y: number; }, basis: MoveBasis): Vec3
-```
-
## desiredResidency — function @experimental
```
(cells: readonly WorldCell[], sources: readonly ResidencySource[], resident: ReadonlySet<string>): ResidencyDecision
@@ -10804,11 +10625,6 @@ EventBindingPlugin
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingYaw — function @experimental
-```
-(direction: Vec3): number
-```
-
## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
@@ -10884,11 +10700,6 @@ FocusPlugin
(): boolean
```
-## gameplayPlugin — const @experimental
-```
-GameplayPlugin
-```
-
## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
@@ -11084,11 +10895,6 @@ GameplayPlugin
() => Plugin[]
```
-## huntTargets — function @experimental
-```
-(world: World, animator: AnimatorControllerAPI | null, attackTrigger: string, dt: number): void
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -11504,11 +11310,6 @@ NodePlatformAdapter
(world: World, events: UIEventQueue, e: Entity): void
```
-## orbitOffset — function @experimental
-```
-(yawDeg: number, pitchDeg: number): Vec3
-```
-
## overlayPose — function @experimental
```
(acc: Pose, layer: Pose, weight: number, world: PoseWorld, reach: LayerReach | null): void
@@ -12009,11 +11810,6 @@ PrefabsPlugin
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveMeleeHits — function @experimental
-```
-(world: World, attacks: MeleeAttacks, queries: MeleeOverlapQuery | null, events: Iterable<AnimatorEventPayload>, damage: { send(blow: DamagePayload): void; }): void
-```
-
## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
@@ -12029,16 +11825,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## restoreToFull — function @experimental
-```
-(world: World, entity: Entity): void
-```
-
-## rootMotionVelocity — function @experimental
-```
-(delta: { x: number; z: number; }, seconds: number): { x: number; z: number; }
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -12359,11 +12145,6 @@ ServicesPlugin
(): string[]
```
-## shortestAngleDelta — function @experimental
-```
-(from: number, to: number): number
-```
-
## shutdownDrawAPI — function @experimental
```
(): void
@@ -12539,11 +12320,6 @@ TrailPlugin
(): number
```
-## turnToward — function @experimental
-```
-(from: number, to: number, degreesPerSecond: number, dt: number): number
-```
-
## uiHitTestWorld — function @experimental
```
(world: PickableWorld, ray: WorldRay, screenRay?: WorldRay): Entity | null
@@ -12774,13 +12550,3 @@ SystemDef
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
-## yawOfQuaternion — function @experimental
-```
-(q: { w: number; y: number; }): number
-```
-
-## yawQuaternion — function @experimental
-```
-(yawDeg: number): { w: number; x: number; y: number; z: number; }
-```
-
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index e29dc3d56..ccbc89e48 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 · 91 beta · 1534 experimental · 3 deprecated
+Symbols: 115 public · 91 beta · 1498 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -2652,21 +2652,6 @@ ScreenScalingData
"unattributed"
```
-## Damage — const @experimental
-```
-EventDef<DamagePayload>
-```
-
-## DamagePayload — interface @experimental
-```
-amount: number
-source: number
-target: number
-x: number
-y: number
-z: number
-```
-
## DataSource — interface @experimental
```
getCount: () => number
@@ -3798,15 +3783,6 @@ index: number
mapping: string
```
-## GameplayPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: () => void
-name: string
-static new (): GameplayPlugin
-static prototype: GameplayPlugin
-```
-
## GearBinding — interface @experimental
```
component: string
@@ -3961,17 +3937,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Health — const @experimental
-```
-ComponentDef<HealthData>
-```
-
-## HealthData — interface @experimental
-```
-current: number
-max: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -4015,35 +3980,6 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## Hunter — const @experimental
-```
-ComponentDef<HunterData>
-```
-
-## HunterData — interface @experimental
-```
-attackInterval: number
-attackRange: number
-cooldown: number
-enabled: boolean
-idleThreshold: number
-rotationSpeed: number
-state: string
-```
-
-## HunterSituation — interface @experimental
-```
-alive: boolean
-attackRange: number
-distance: number
-visible: boolean
-```
-
-## HunterState — type @experimental
-```
-'idle' | 'chase' | 'attack' | 'dead'
-```
-
## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
@@ -4906,39 +4842,6 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MeleeAttack — const @experimental
-```
-ComponentDef<MeleeAttackData>
-```
-
-## MeleeAttackData — interface @experimental
-```
-anchor: number
-attackId: number
-damage: number
-enabled: boolean
-hitCount: number
-layers: number
-radius: number
-```
-
-## MeleeAttacks — class @experimental
-```
-clear: () => void
-close: (entity: Entity) => void
-forget: (entity: Entity) => void
-live: (entity: Entity) => { id: number; hits: number; } | null
-open: (entity: Entity) => number
-record: (entity: Entity, target: Entity) => boolean
-static new (): MeleeAttacks
-static prototype: MeleeAttacks
-```
-
-## MeleeOverlapQuery — interface @experimental
-```
-overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
-```
-
## MeshChannel — const @experimental
```
{ readonly Position: 0; readonly Color: 1; readonly TexCoord0: 2; readonly Normal: 3; readonly Tangent: 4; readonly Joints: 5; readonly Weights: 6; readonly TexCoord1: 7; }
@@ -5415,12 +5318,6 @@ ComponentDef<MotorJoint2DData>
(button: number) => Binding
```
-## MoveBasis — interface @experimental
-```
-forward: Vec3
-right: Vec3
-```
-
## Mut — function @public
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
@@ -8373,6 +8270,11 @@ readonly (keyof ThemeColors)[]
"grounded"
```
+## TPC_JUMP — const @experimental
+```
+"jump"
+```
+
## TPC_SPEED — const @experimental
```
"speed"
@@ -8684,47 +8586,6 @@ label: number
title: number
```
-## ThirdPersonCamera — const @experimental
-```
-ComponentDef<ThirdPersonCameraData>
-```
-
-## ThirdPersonCameraData — interface @experimental
-```
-distance: number
-enabled: boolean
-followDamping: number
-maxPitch: number
-minPitch: number
-obstruction: boolean
-obstructionLayers: number
-obstructionRadius: number
-pitch: number
-sensitivity: number
-target: number
-targetOffset: Vec3
-yaw: number
-```
-
-## ThirdPersonController — const @experimental
-```
-ComponentDef<ThirdPersonControllerData>
-```
-
-## ThirdPersonControllerData — interface @experimental
-```
-acceleration: number
-airControl: number
-camera: number
-cameraRelative: boolean
-deceleration: number
-enabled: boolean
-idleThreshold: number
-jumpSpeed: number
-moveSpeed: number
-rotationSpeed: number
-```
-
## Time — const @public
```
ResourceDef<TimeData>
@@ -9652,11 +9513,6 @@ y: number
(id: string) => Binding
```
-## WORLD_BASIS — const @experimental
-```
-MoveBasis
-```
-
## WORLD_DIR — const @experimental
```
"world"
@@ -10157,11 +10013,6 @@ AnimationPlugin
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDamage — function @experimental
-```
-(world: World, blows: Iterable<DamagePayload>): void
-```
-
## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
@@ -10187,11 +10038,6 @@ AnimationPlugin
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## approachVelocity — function @experimental
-```
-(current: { x: number; z: number; }, target: { x: number; z: number; }, acceleration: number, deceleration: number, dt: number): { x: number; z: number; }
-```
-
## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
@@ -10352,11 +10198,6 @@ MotionDriver<AnimatorBlend2DMotion>
(camera: CameraFields, transform: CameraTransformFields, width: number, height: number, canvas: CanvasScale | null, result?: Float32Array): Float32Array
```
-## cameraGroundBasis — function @experimental
-```
-(yawDeg: number): { forward: Vec3; right: Vec3; }
-```
-
## canCaptureFramePixels — function @experimental
```
(module: ESEngineModule): boolean
@@ -10397,11 +10238,6 @@ MotionDriver<AnimatorBlend2DMotion>
(): string[]
```
-## clampPitch — function @experimental
-```
-(pitch: number, min: number, max: number): number
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -10702,21 +10538,11 @@ Plugin
(scene: SceneData, sceneName: string, options: PartitionOptions): CutWorld | null
```
-## dampFactor — function @experimental
-```
-(damping: number, dt: number): number
-```
-
## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decideHunterState — function @experimental
-```
-(s: HunterSituation): HunterState
-```
-
## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
@@ -10792,11 +10618,6 @@ PluralSelector
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## desiredDirection — function @experimental
-```
-(input: { x: number; y: number; }, basis: MoveBasis): Vec3
-```
-
## desiredResidency — function @experimental
```
(cells: readonly WorldCell[], sources: readonly ResidencySource[], resident: ReadonlySet<string>): ResidencyDecision
@@ -11067,11 +10888,6 @@ EventBindingPlugin
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingYaw — function @experimental
-```
-(direction: Vec3): number
-```
-
## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
@@ -11147,11 +10963,6 @@ FocusPlugin
(): boolean
```
-## gameplayPlugin — const @experimental
-```
-GameplayPlugin
-```
-
## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
@@ -11347,11 +11158,6 @@ GameplayPlugin
() => Plugin[]
```
-## huntTargets — function @experimental
-```
-(world: World, animator: AnimatorControllerAPI | null, attackTrigger: string, dt: number): void
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -11767,11 +11573,6 @@ MeshRendererPlugin
(world: World, events: UIEventQueue, e: Entity): void
```
-## orbitOffset — function @experimental
-```
-(yawDeg: number, pitchDeg: number): Vec3
-```
-
## overlayPose — function @experimental
```
(acc: Pose, layer: Pose, weight: number, world: PoseWorld, reach: LayerReach | null): void
@@ -12272,11 +12073,6 @@ PrefabsPlugin
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveMeleeHits — function @experimental
-```
-(world: World, attacks: MeleeAttacks, queries: MeleeOverlapQuery | null, events: Iterable<AnimatorEventPayload>, damage: { send(blow: DamagePayload): void; }): void
-```
-
## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
@@ -12292,16 +12088,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## restoreToFull — function @experimental
-```
-(world: World, entity: Entity): void
-```
-
-## rootMotionVelocity — function @experimental
-```
-(delta: { x: number; z: number; }, seconds: number): { x: number; z: number; }
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -12622,11 +12408,6 @@ ServicesPlugin
(): string[]
```
-## shortestAngleDelta — function @experimental
-```
-(from: number, to: number): number
-```
-
## shutdownDrawAPI — function @experimental
```
(): void
@@ -12802,11 +12583,6 @@ TrailPlugin
(): number
```
-## turnToward — function @experimental
-```
-(from: number, to: number, degreesPerSecond: number, dt: number): number
-```
-
## uiHitTestWorld — function @experimental
```
(world: PickableWorld, ray: WorldRay, screenRay?: WorldRay): Entity | null
@@ -13037,13 +12813,3 @@ SystemDef
(f32: Float32Array, u32: Uint32Array, u8: Uint8Array, ptr: number, field: PtrFieldDesc, value: PtrFieldValue | unknown): void
```
-## yawOfQuaternion — function @experimental
-```
-(q: { w: number; y: number; }): number
-```
-
-## yawQuaternion — function @experimental
-```
-(yawDeg: number): { w: number; x: number; y: number; z: number; }
-```
-
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index 76429a0f9..91f3f4e7c 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 · 91 beta · 1525 experimental · 3 deprecated
+Symbols: 115 public · 91 beta · 1489 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -2652,21 +2652,6 @@ ScreenScalingData
"unattributed"
```
-## Damage — const @experimental
-```
-EventDef<DamagePayload>
-```
-
-## DamagePayload — interface @experimental
-```
-amount: number
-source: number
-target: number
-x: number
-y: number
-z: number
-```
-
## DataSource — interface @experimental
```
getCount: () => number
@@ -3798,15 +3783,6 @@ index: number
mapping: string
```
-## GameplayPlugin — class @experimental
-```
-build: (app: App) => void
-cleanup: () => void
-name: string
-static new (): GameplayPlugin
-static prototype: GameplayPlugin
-```
-
## GearBinding — interface @experimental
```
component: string
@@ -3961,17 +3937,6 @@ plugins: Plugin[] | undefined
sideModules: SideModuleHost | undefined
```
-## Health — const @experimental
-```
-ComponentDef<HealthData>
-```
-
-## HealthData — interface @experimental
-```
-current: number
-max: number
-```
-
## HingeJoint2D — const @experimental
```
ComponentDef<HingeJoint2DData>
@@ -4015,35 +3980,6 @@ static new (options: HttpBackendOptions): HttpBackend
static prototype: HttpBackend
```
-## Hunter — const @experimental
-```
-ComponentDef<HunterData>
-```
-
-## HunterData — interface @experimental
-```
-attackInterval: number
-attackRange: number
-cooldown: number
-enabled: boolean
-idleThreshold: number
-rotationSpeed: number
-state: string
-```
-
-## HunterSituation — interface @experimental
-```
-alive: boolean
-attackRange: number
-distance: number
-visible: boolean
-```
-
-## HunterState — type @experimental
-```
-'idle' | 'chase' | 'attack' | 'dead'
-```
-
## INTERACTION_CONTROLLER — const @experimental
```
"$interaction"
@@ -4913,39 +4849,6 @@ static new (opts: MeasuredLinearLayoutOptions): MeasuredLinearLayoutProvider
static prototype: MeasuredLinearLayoutProvider
```
-## MeleeAttack — const @experimental
-```
-ComponentDef<MeleeAttackData>
-```
-
-## MeleeAttackData — interface @experimental
-```
-anchor: number
-attackId: number
-damage: number
-enabled: boolean
-hitCount: number
-layers: number
-radius: number
-```
-
-## MeleeAttacks — class @experimental
-```
-clear: () => void
-close: (entity: Entity) => void
-forget: (entity: Entity) => void
-live: (entity: Entity) => { id: number; hits: number; } | null
-open: (entity: Entity) => number
-record: (entity: Entity, target: Entity) => boolean
-static new (): MeleeAttacks
-static prototype: MeleeAttacks
-```
-
-## MeleeOverlapQuery — interface @experimental
-```
-overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
-```
-
## MeshChannel — const @experimental
```
{ readonly Position: 0; readonly Color: 1; readonly TexCoord0: 2; readonly Normal: 3; readonly Tangent: 4; readonly Joints: 5; readonly Weights: 6; readonly TexCoord1: 7; }
@@ -5170,12 +5073,6 @@ ComponentDef<MotorJoint2DData>
(button: number) => Binding
```
-## MoveBasis — interface @experimental
-```
-forward: Vec3
-right: Vec3
-```
-
## Mut — function @public
```
<T extends AnyComponentDef>(component: T): MutWrapper<T>
@@ -8128,6 +8025,11 @@ readonly (keyof ThemeColors)[]
"grounded"
```
+## TPC_JUMP — const @experimental
+```
+"jump"
+```
+
## TPC_SPEED — const @experimental
```
"speed"
@@ -8439,47 +8341,6 @@ label: number
title: number
```
-## ThirdPersonCamera — const @experimental
-```
-ComponentDef<ThirdPersonCameraData>
-```
-
-## ThirdPersonCameraData — interface @experimental
-```
-distance: number
-enabled: boolean
-followDamping: number
-maxPitch: number
-minPitch: number
-obstruction: boolean
-obstructionLayers: number
-obstructionRadius: number
-pitch: number
-sensitivity: number
-target: number
-targetOffset: Vec3
-yaw: number
-```
-
-## ThirdPersonController — const @experimental
-```
-ComponentDef<ThirdPersonControllerData>
-```
-
-## ThirdPersonControllerData — interface @experimental
-```
-acceleration: number
-airControl: number
-camera: number
-cameraRelative: boolean
-deceleration: number
-enabled: boolean
-idleThreshold: number
-jumpSpeed: number
-moveSpeed: number
-rotationSpeed: number
-```
-
## Time — const @public
```
ResourceDef<TimeData>
@@ -9401,11 +9262,6 @@ y: number
(id: string) => Binding
```
-## WORLD_BASIS — const @experimental
-```
-MoveBasis
-```
-
## WORLD_DIR — const @experimental
```
"world"
@@ -9927,11 +9783,6 @@ AnimationPlugin
(app: { setMaxDeltaTime(v: number): void; setMaxFixedSteps(v: number): void; }, config: RuntimeBuildConfig): void
```
-## applyDamage — function @experimental
-```
-(world: World, blows: Iterable<DamagePayload>): void
-```
-
## applyDeltaToSource — function @experimental
```
(source: PrefabData, delta: SourceDelta): PrefabData
@@ -9957,11 +9808,6 @@ AnimationPlugin
(time: number, duration: number, mode: WrapMode): { time: number; stopped: boolean; }
```
-## approachVelocity — function @experimental
-```
-(current: { x: number; z: number; }, target: { x: number; z: number; }, acceleration: number, deceleration: number, dt: number): { x: number; z: number; }
-```
-
## arrayDataSource — function @experimental
```
<T>(items: readonly T[]): ArrayDataSource<T>
@@ -10122,11 +9968,6 @@ MotionDriver<AnimatorBlend2DMotion>
(camera: CameraFields, transform: CameraTransformFields, width: number, height: number, canvas: CanvasScale | null, result?: Float32Array): Float32Array
```
-## cameraGroundBasis — function @experimental
-```
-(yawDeg: number): { forward: Vec3; right: Vec3; }
-```
-
## canCaptureFramePixels — function @experimental
```
(module: ESEngineModule): boolean
@@ -10167,11 +10008,6 @@ MotionDriver<AnimatorBlend2DMotion>
(): string[]
```
-## clampPitch — function @experimental
-```
-(pitch: number, min: number, max: number): number
-```
-
## clearAnimatorControllerStore — function @experimental
```
(): void
@@ -10467,21 +10303,11 @@ Plugin
(scene: SceneData, sceneName: string, options: PartitionOptions): CutWorld | null
```
-## dampFactor — function @experimental
-```
-(damping: number, dt: number): number
-```
-
## debug — function @experimental
```
(category: string, message: string, data?: unknown): void
```
-## decideHunterState — function @experimental
-```
-(s: HunterSituation): HunterState
-```
-
## decodeImageBitmap — function @experimental
```
(src: ImageBitmapSource | PlatformImage, flip: boolean): Promise<ImageBitmap>
@@ -10557,11 +10383,6 @@ PluralSelector
<T>(sources: ReadonlySignal<unknown>[], compute: () => T): ReadonlySignal<T>
```
-## desiredDirection — function @experimental
-```
-(input: { x: number; y: number; }, basis: MoveBasis): Vec3
-```
-
## desiredResidency — function @experimental
```
(cells: readonly WorldCell[], sources: readonly ResidencySource[], resident: ReadonlySet<string>): ResidencyDecision
@@ -10832,11 +10653,6 @@ EventBindingPlugin
(entities: readonly ExtractEntity[], rootId: number, name: string, makeId?: (sourceId: number) => PrefabEntityId): PrefabData
```
-## facingYaw — function @experimental
-```
-(direction: Vec3): number
-```
-
## fetchDecodePixels — function @experimental
```
(url: string): Promise<DecodedPixels>
@@ -10912,11 +10728,6 @@ FocusPlugin
(): boolean
```
-## gameplayPlugin — const @experimental
-```
-GameplayPlugin
-```
-
## gearBinding — function @experimental
```
(controller: string, component: string, property: string, pages: Record<string, GearValue>, tween?: GearTween): GearBinding
@@ -11112,11 +10923,6 @@ GameplayPlugin
() => Plugin[]
```
-## huntTargets — function @experimental
-```
-(world: World, animator: AnimatorControllerAPI | null, attackTrigger: string, dt: number): void
-```
-
## imageBitmapOptions — function @experimental
```
(flip: boolean): ImageBitmapOptions
@@ -11532,11 +11338,6 @@ MeshRendererPlugin
(world: World, events: UIEventQueue, e: Entity): void
```
-## orbitOffset — function @experimental
-```
-(yawDeg: number, pitchDeg: number): Vec3
-```
-
## overlayPose — function @experimental
```
(acc: Pose, layer: Pose, weight: number, world: PoseWorld, reach: LayerReach | null): void
@@ -12037,11 +11838,6 @@ PrefabsPlugin
(world: Pick<World, "tryGet">, rootEntity: Entity, childPath: string): Entity | null
```
-## resolveMeleeHits — function @experimental
-```
-(world: World, attacks: MeleeAttacks, queries: MeleeOverlapQuery | null, events: Iterable<AnimatorEventPayload>, damage: { send(blow: DamagePayload): void; }): void
-```
-
## resolveParams — function @experimental
```
(def: AnimatorControllerDef, overrides: ReadonlyMap<string, number | boolean>): Record<string, number | boolean>
@@ -12057,16 +11853,6 @@ PrefabsPlugin
(base: "dark" | "light", overrides?: ThemeOverrides): ThemeTokens
```
-## restoreToFull — function @experimental
-```
-(world: World, entity: Entity): void
-```
-
-## rootMotionVelocity — function @experimental
-```
-(delta: { x: number; z: number; }, seconds: number): { x: number; z: number; }
-```
-
## rotateVec3ByQuat — function @experimental
```
(rot: Quat, v: Vec3): Vec3
@@ -12387,11 +12173,6 @@ ServicesPlugin
(): string[]
```
-## shortestAngleDelta — function @experimental
-```
-(from: number, to: number): number
-```
-
## shutdownDrawAPI — function @experimental
```
(): void
@@ -12567,11 +12348,6 @@ TrailPlugin
(): number
```
-## turnToward — function @experimental
-```
-(from: number, to: number, degreesPerSecond: number, dt: number): number
-```
-
## uiHitTestWorld — function @experimental
```
(world: PickableWorld, ray: WorldRay, screenRay?: WorldRay): Entity | null
@@ -12847,13 +12623,3 @@ SystemDef
(path: string, data: string | ArrayBuffer): Promise<void>
```
-## yawOfQuaternion — function @experimental
-```
-(q: { w: number; y: number; }): number
-```
-
-## yawQuaternion — function @experimental
-```
-(yawDeg: number): { w: number; x: number; y: number; z: number; }
-```
-
diff --git a/sdk/package.json b/sdk/package.json
index b4c1b4b20..4c0c134d5 100644
--- a/sdk/package.json
+++ b/sdk/package.json
@@ -19,6 +19,7 @@
"./dist/logic/index.js",
"./dist/ai/index.js",
"./dist/net/replication/index.js",
+ "./dist/gameplay/index.js",
"./dist/physics/index.js",
"./dist/physics3d/index.js",
"./dist/douyin/index.js",
@@ -74,6 +75,10 @@
"import": "./dist/net/replication/index.js",
"types": "./dist/net/replication/index.d.ts"
},
+ "./gameplay": {
+ "import": "./dist/gameplay/index.js",
+ "types": "./dist/gameplay/index.d.ts"
+ },
"./physics": {
"import": "./dist/physics/index.js",
"types": "./dist/physics/index.d.ts"
diff --git a/sdk/rolldown.config.js b/sdk/rolldown.config.js
index ab1e58d5d..d3ca403a3 100644
--- a/sdk/rolldown.config.js
+++ b/sdk/rolldown.config.js
@@ -99,6 +99,7 @@ export default defineConfig([
'logic/index': 'src/logic/index.ts',
'ai/index': 'src/ai/index.ts',
'net/replication/index': 'src/net/replication/index.ts',
+ 'gameplay/index': 'src/gameplay/index.ts',
'dragonbones/index': 'src/dragonbones/index.ts',
'douyin/index': 'src/platform/douyin/index.ts',
'wasm': 'src/wasm.ts',
diff --git a/sdk/rollup.config.js b/sdk/rollup.config.js
index c3a9aba57..92695b505 100644
--- a/sdk/rollup.config.js
+++ b/sdk/rollup.config.js
@@ -22,6 +22,7 @@ export default [
'logic/index': 'src/logic/index.ts',
'ai/index': 'src/ai/index.ts',
'net/replication/index': 'src/net/replication/index.ts',
+ 'gameplay/index': 'src/gameplay/index.ts',
'dragonbones/index': 'src/dragonbones/index.ts',
'wasm': 'src/wasm.ts',
},
diff --git a/sdk/src/app/pluginSets.ts b/sdk/src/app/pluginSets.ts
index 3cf1c93a8..356f2edc3 100644
--- a/sdk/src/app/pluginSets.ts
+++ b/sdk/src/app/pluginSets.ts
@@ -29,7 +29,6 @@ import { trailPlugin } from '../trail';
import { meshRendererPlugin } from '../render/meshRenderer';
import { postProcessPlugin } from '../postprocess';
import { timelinePlugin } from '../timeline';
-import { gameplayPlugin } from '../gameplay';
import { timerPlugin } from '../ecs/timer';
import { velocityPlugin } from '../velocity';
import { lifecyclePlugin } from '../ecs/lifecycle';
@@ -58,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,
- postProcessPlugin, timelinePlugin, gameplayPlugin,
+ postProcessPlugin, timelinePlugin,
];
/**
@@ -95,7 +94,6 @@ export const webBasePlugins = (): Plugin[] => [
diagnosticsPlugin,
timerPlugin, velocityPlugin, lifecyclePlugin, animationPlugin, audioPlugin, videoPlugin,
particlePlugin, trailPlugin, meshRendererPlugin, postProcessPlugin, timelinePlugin,
- gameplayPlugin,
eventBindingPlugin,
servicesPlugin,
];
diff --git a/sdk/src/core-content.ts b/sdk/src/core-content.ts
index a82329c56..7cffc863b 100644
--- a/sdk/src/core-content.ts
+++ b/sdk/src/core-content.ts
@@ -767,60 +767,27 @@ export type {
// =============================================================================
-// Gameplay (third-person character + camera)
+// Gameplay — the NAMES authored content reaches it by; the runtime is
+// `esengine/gameplay`. From their own module rather than from './gameplay',
+// which would put the components and the solver back.
// =============================================================================
export {
- GameplayPlugin,
- gameplayPlugin,
- ThirdPersonController,
- ThirdPersonCamera,
TPC_SPEED,
TPC_GROUNDED,
+ TPC_JUMP,
TPC_DODGE,
TPC_ATTACK,
- desiredDirection,
- approachVelocity,
- facingYaw,
- shortestAngleDelta,
- turnToward,
- yawQuaternion,
- yawOfQuaternion,
- cameraGroundBasis,
- orbitOffset,
- dampFactor,
- clampPitch,
- rootMotionVelocity,
- WORLD_BASIS,
DODGE_KEY,
ATTACK_KEY,
- Hunter,
- decideHunterState,
- huntTargets,
- type HunterData,
- type HunterState,
- type HunterSituation,
- Health,
- Damage,
- applyDamage,
- restoreToFull,
- MeleeAttack,
- MeleeAttacks,
- resolveMeleeHits,
COMBAT_ATTACK_START,
COMBAT_HIT,
COMBAT_ATTACK_END,
- type HealthData,
- type DamagePayload,
- type MeleeAttackData,
- type MeleeOverlapQuery,
- type ThirdPersonControllerData,
- type ThirdPersonCameraData,
- type MoveBasis,
- Playthrough,
- type PlaythroughData,
- type PlaythroughValue,
-} from './gameplay';
+} from './gameplay/vocabulary';
+
+/** What a game says about its own run, for the observation seam a packaged game
+ * already has. Core rather than `esengine/gameplay`: every host reads it. */
+export { Playthrough, type PlaythroughData, type PlaythroughValue } from './runtime/playthrough';
// =============================================================================
// Timeline (Sequencer)
diff --git a/sdk/src/gameplay/GameplayPlugin.ts b/sdk/src/gameplay/GameplayPlugin.ts
index 30a226117..b7515576a 100644
--- a/sdk/src/gameplay/GameplayPlugin.ts
+++ b/sdk/src/gameplay/GameplayPlugin.ts
@@ -32,7 +32,7 @@ import { huntTargets } from './Hunter';
import { q } from '../math/quat';
import type { World } from '../ecs/world';
import type { Entity } from '../types';
-import { Playthrough } from './Playthrough';
+import { Playthrough } from '../runtime/playthrough';
import {
ThirdPersonController, type ThirdPersonControllerData,
desiredDirection, approachVelocity, facingYaw, turnToward, rootMotionVelocity,
diff --git a/sdk/src/gameplay/MeleeAttack.ts b/sdk/src/gameplay/MeleeAttack.ts
index 911fca2a7..7ecfd3d20 100644
--- a/sdk/src/gameplay/MeleeAttack.ts
+++ b/sdk/src/gameplay/MeleeAttack.ts
@@ -28,13 +28,8 @@ import type { Overlap3DHit } from '../physics3d/Physics3DQueries';
import type { AnimatorEventPayload } from '../animation/animatorEvent';
import { Health, type DamagePayload, type HealthData } from './Health';
-/**
- * The events a clip declares that this reads. Names rather than times: a state
- * that re-times its swing re-times the hit, and nothing else has to be told.
- */
-export const COMBAT_ATTACK_START = 'attack-start';
-export const COMBAT_HIT = 'hit';
-export const COMBAT_ATTACK_END = 'attack-end';
+import { COMBAT_ATTACK_START, COMBAT_HIT, COMBAT_ATTACK_END } from './vocabulary';
+export { COMBAT_ATTACK_START, COMBAT_HIT, COMBAT_ATTACK_END } from './vocabulary';
/** The fields of the `MeleeAttack` component. @experimental */
export interface MeleeAttackData {
diff --git a/sdk/src/gameplay/ThirdPersonController.ts b/sdk/src/gameplay/ThirdPersonController.ts
index 6855fe6b8..16efcde4c 100644
--- a/sdk/src/gameplay/ThirdPersonController.ts
+++ b/sdk/src/gameplay/ThirdPersonController.ts
@@ -20,23 +20,11 @@ import { defineComponent, type ComponentDef } from '../ecs/component';
import type { Entity } from '../types';
import type { Vec3 } from '../types';
-/**
- * Animator parameters a controller writes, and the triggers it sets. Names, not
- * clips — and shared with {@link Hunter}, so one graph drives a player and an
- * enemy and neither can drift into a private vocabulary.
- */
-export const TPC_SPEED = 'speed';
-export const TPC_GROUNDED = 'grounded';
-/** Set the frame a jump was ACCEPTED, not the frame one was asked for. */
-export const TPC_JUMP = 'jump';
-export const TPC_DODGE = 'dodge';
-export const TPC_ATTACK = 'attack';
-
-/** The key a dodge is asked for on; the animator decides whether there is one. */
-export const DODGE_KEY = 'ShiftLeft';
-
-/** The key an attack is asked for on. Same rule: a request, not a clip name. */
-export const ATTACK_KEY = 'KeyJ';
+// The names authored content reaches this through live on `esengine`; the
+// runtime does not, so they are declared apart from it.
+export {
+ TPC_SPEED, TPC_GROUNDED, TPC_JUMP, TPC_DODGE, TPC_ATTACK, DODGE_KEY, ATTACK_KEY,
+} from './vocabulary';
/** The fields of the `ThirdPersonController` component. @experimental */
export interface ThirdPersonControllerData {
diff --git a/sdk/src/gameplay/gameplaySupport.ts b/sdk/src/gameplay/gameplaySupport.ts
new file mode 100644
index 000000000..aed45ae10
--- /dev/null
+++ b/sdk/src/gameplay/gameplaySupport.ts
@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file gameplaySupport.ts — what a build that ships the gameplay runtime tells
+ * the core. A call, not a file's side effect — see spine/spineSupport.ts.
+ *
+ * From the plugin's own module rather than from './index': the barrel calls this
+ * at the end of its own evaluation, and a support module reading the barrel back
+ * is a cycle whose bindings are not ready when the call lands.
+ */
+import { addEntryPlugin } from '../runtime/entryPlugins';
+import { GameplayPlugin } from './GameplayPlugin';
+
+export function registerGameplaySupport(): void {
+ addEntryPlugin('gameplay', () => new GameplayPlugin());
+}
diff --git a/sdk/src/gameplay/index.ts b/sdk/src/gameplay/index.ts
index bd0cf9d7d..653f0caec 100644
--- a/sdk/src/gameplay/index.ts
+++ b/sdk/src/gameplay/index.ts
@@ -68,8 +68,8 @@ export {
updateCameras,
} from './GameplayPlugin';
-export {
- Playthrough,
- type PlaythroughData,
- type PlaythroughValue,
-} from './Playthrough';
+
+// Importing this subpath INSTALLS the gameplay runtime — see spine/index.ts.
+import { registerGameplaySupport } from './gameplaySupport';
+
+registerGameplaySupport();
diff --git a/sdk/src/gameplay/vocabulary.ts b/sdk/src/gameplay/vocabulary.ts
new file mode 100644
index 000000000..0994248e2
--- /dev/null
+++ b/sdk/src/gameplay/vocabulary.ts
@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file vocabulary.ts — the names authored content uses to reach gameplay.
+ *
+ * Strings, and its own module because of who reads them: an AnimatorController
+ * asset names the parameters, an input map names the keys, and an event binding
+ * names the combat events — none of which needs a controller, a health bar or a
+ * melee solver. These stay on `esengine`; the runtime behind them is
+ * `esengine/gameplay`.
+ */
+
+/**
+ * Animator parameters a controller writes, and the triggers it sets. Names, not
+ * clips — and shared with the hunter, so one graph drives a player and an enemy
+ * and neither can drift into a private vocabulary.
+ */
+export const TPC_SPEED = 'speed';
+export const TPC_GROUNDED = 'grounded';
+/** Set the frame a jump was ACCEPTED, not the frame one was asked for. */
+export const TPC_JUMP = 'jump';
+export const TPC_DODGE = 'dodge';
+export const TPC_ATTACK = 'attack';
+
+/** The key a dodge is asked for on; the animator decides whether there is one. */
+export const DODGE_KEY = 'ShiftLeft';
+
+/** The key an attack is asked for on. Same rule: a request, not a clip name. */
+export const ATTACK_KEY = 'KeyJ';
+
+/**
+ * The events a clip declares that melee reads. Names rather than times: a state
+ * that re-times its swing re-times the hit, and nothing else has to be told.
+ */
+export const COMBAT_ATTACK_START = 'attack-start';
+export const COMBAT_HIT = 'hit';
+export const COMBAT_ATTACK_END = 'attack-end';
diff --git a/sdk/src/platform/nativeModuleRegistry.ts b/sdk/src/platform/nativeModuleRegistry.ts
index 161637724..ff135624b 100644
--- a/sdk/src/platform/nativeModuleRegistry.ts
+++ b/sdk/src/platform/nativeModuleRegistry.ts
@@ -27,6 +27,7 @@ import * as TilemapModule from '../tilemap';
import * as ScriptGraphModule from '../logic';
import * as AiModule from '../ai';
import * as ReplicationModule from '../net/replication';
+import * as GameplayModule from '../gameplay';
/** Must equal NATIVE_MODULE_REGISTRY in tools/nativeScriptModules.mjs, which is
* what the exporter emits and what check-native-script-modules reads. */
@@ -45,6 +46,7 @@ export const NATIVE_MODULE_NAMESPACES: Readonly<Record<string, unknown>> = {
'esengine/logic': ScriptGraphModule,
'esengine/ai': AiModule,
'esengine/replication': ReplicationModule,
+ 'esengine/gameplay': GameplayModule,
};
/**
diff --git a/sdk/src/runtime/optionalPlugins.ts b/sdk/src/runtime/optionalPlugins.ts
index 095c4efdb..235074384 100644
--- a/sdk/src/runtime/optionalPlugins.ts
+++ b/sdk/src/runtime/optionalPlugins.ts
@@ -23,6 +23,7 @@ import { registerTilemapSupport } from '../tilemap/tilemapSupport';
import { registerScriptGraphSupport } from '../logic/logicSupport';
import { registerAiSupport } from '../ai/aiSupport';
import { registerReplicationSupport } from '../net/replication/replicationSupport';
+import { registerGameplaySupport } from '../gameplay/gameplaySupport';
export function installOptionalPlugins(): void {
registerSpineSupport();
@@ -33,6 +34,7 @@ export function installOptionalPlugins(): void {
registerScriptGraphSupport();
registerAiSupport();
registerReplicationSupport();
+ registerGameplaySupport();
// Video has no subpath of its own to be installed from, so it registers here.
setSceneOptionals({
video: {
diff --git a/sdk/src/gameplay/Playthrough.ts b/sdk/src/runtime/playthrough.ts
similarity index 90%
rename from sdk/src/gameplay/Playthrough.ts
rename to sdk/src/runtime/playthrough.ts
index 426c95a35..c59065e1f 100644
--- a/sdk/src/gameplay/Playthrough.ts
+++ b/sdk/src/runtime/playthrough.ts
@@ -16,6 +16,9 @@
* resources and guess which field means "won" — the game states it, in
* its own words, and that statement is the contract. Read-only from
* outside: this is how a run is OBSERVED, never how it is driven.
+ *
+ * Core, not `gameplay`: the host's observation seam reads it from every
+ * packaged game, and it depends on nothing the gameplay runtime has.
*/
import { defineResource } from '../ecs/resource';
diff --git a/tools/lib/sdkProgram.mjs b/tools/lib/sdkProgram.mjs
index 5d9b35bfa..68a75fb50 100644
--- a/tools/lib/sdkProgram.mjs
+++ b/tools/lib/sdkProgram.mjs
@@ -62,6 +62,7 @@ export const ENTRIES = {
'logic': 'src/logic/index.ts',
'ai': 'src/ai/index.ts',
'replication': 'src/net/replication/index.ts',
+ 'gameplay': 'src/gameplay/index.ts',
'wasm': 'src/wasm.ts',
'wechat': 'src/index.wechat.ts',
'minigame': 'src/index.minigame.ts',
diff --git a/tools/nativeScriptModules.js b/tools/nativeScriptModules.js
index a2468eff5..141c39a14 100644
--- a/tools/nativeScriptModules.js
+++ b/tools/nativeScriptModules.js
@@ -68,6 +68,7 @@ export const MODULES = {
'esengine/logic': { disposition: 'native-subpath' },
'esengine/ai': { disposition: 'native-subpath' },
'esengine/replication': { disposition: 'native-subpath' },
+ 'esengine/gameplay': { disposition: 'native-subpath' },
'esengine/native': {
disposition: 'forbidden-native-script',