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(net): replication moves to its own subpath

esengine5a76d5a48a4b
diff --git a/desktop b/desktop
index 8bbc2f7ef..948edb90d 160000
--- a/desktop
+++ b/desktop
@@ -1 +1 @@
-Subproject commit 8bbc2f7efbf0cae84407b68c344435070695a0cd
+Subproject commit 948edb90d1f1c9f1c906b888f5b294d048516a3f
diff --git a/docs/astro/src/data/apiStability.generated.json b/docs/astro/src/data/apiStability.generated.json
index 5466f26e7..558b8e109 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": 2054,
+ "experimental": 2087,
"deprecated": 3
},
- "total": 2272,
+ "total": 2305,
"subsystems": [
{
"id": "ecs",
diff --git a/examples/multiplayer-arena/src/net.ts b/examples/multiplayer-arena/src/net.ts
index 4f0bc97de..84650ac61 100644
--- a/examples/multiplayer-arena/src/net.ts
+++ b/examples/multiplayer-arena/src/net.ts
@@ -1,9 +1,11 @@
import {
defineSystem, Res, GetWorld,
- Time, Input, Net, Replicated, Transform, Sprite,
- registerReplicationArchetype,
+ Time, Input, Transform, Sprite,
type World, type Entity, type InputState,
} from 'esengine';
+// Replication is a subpath: a package that imports it carries the protocol,
+// and one that does not carries none of it.
+import { Net, Replicated, registerReplicationArchetype } from 'esengine/replication';
import { Pawn } from './components';
// Arena bounds the movement rule clamps pawns to (matches the scene's walls).
diff --git a/examples/multiplayer-arena/tsconfig.json b/examples/multiplayer-arena/tsconfig.json
index 1f11ff310..eddaf1dc5 100644
--- a/examples/multiplayer-arena/tsconfig.json
+++ b/examples/multiplayer-arena/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/replication": ["./.esengine/sdk/net/replication/index.d.ts"]
}
},
"include": ["src/**/*"],
diff --git a/pipeline/src/bundle/esengineResolve.ts b/pipeline/src/bundle/esengineResolve.ts
index c66316186..6e7083874 100644
--- a/pipeline/src/bundle/esengineResolve.ts
+++ b/pipeline/src/bundle/esengineResolve.ts
@@ -27,6 +27,7 @@ export const ESENGINE_SUBPATHS: Readonly<Record<string, string>> = {
'esengine/tilemap': 'tilemap/index.js',
'esengine/logic': 'logic/index.js',
'esengine/ai': 'ai/index.js',
+ 'esengine/replication': 'net/replication/index.js',
'esengine/dragonbones': 'dragonbones/index.js',
'esengine/physics': 'physics/index.js',
'esengine/physics3d': 'physics3d/index.js',
diff --git a/pipeline/src/export/exportMiniGame.ts b/pipeline/src/export/exportMiniGame.ts
index 396c4a199..23996d213 100644
--- a/pipeline/src/export/exportMiniGame.ts
+++ b/pipeline/src/export/exportMiniGame.ts
@@ -468,6 +468,7 @@ export async function exportMiniGame(profile: MiniGameExportProfile, opts: {
const CONTENT_SUBPATH: Partial<Record<Subsystem, string>> = {
tilemap: 'esengine/tilemap',
ai: 'esengine/ai',
+ replication: 'esengine/replication',
};
/** …and the ones a document names by asset rather than by component. */
const ASSET_SUBPATH: Readonly<Record<string, string>> = {
diff --git a/pipeline/src/project/targetSupport.ts b/pipeline/src/project/targetSupport.ts
index ec9e23716..b9d339aec 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';
+export type Subsystem = 'text' | 'tilemap' | 'particles' | 'postprocess' | 'physics' | 'spine' | 'video' | 'ai' | 'replication';
/**
* The authored vocabulary that puts a subsystem in use: a scene or prefab
@@ -50,6 +50,7 @@ export const SUBSYSTEM_COMPONENTS: Readonly<Record<Subsystem, readonly string[]>
'NavAgent', 'NavArea', 'NavLink', 'NavObstacle', 'NavVolume',
'Perceiver', 'Perception', 'StateMachineAgent', 'BehaviorTreeAgent',
],
+ replication: ['Replicated', 'NetGhost'],
};
/** Human name, for a message someone packaging a game has to act on. */
@@ -62,6 +63,7 @@ export const SUBSYSTEM_LABEL: Readonly<Record<Subsystem, string>> = {
spine: 'Spine animation',
video: 'Video',
ai: 'Gameplay AI',
+ replication: 'Replication',
};
/**
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 8a540d3a8..9d11dca82 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 · 1548 experimental · 3 deprecated
+Symbols: 115 public · 91 beta · 1513 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -1499,11 +1499,6 @@ p2x: number
p2y: number
```
-## BinaryHandler — type @experimental
-```
-(payload: Uint8Array) => void
-```
-
## Binding — type @public
```
| { kind: 'key'; code: string }
@@ -4298,48 +4293,6 @@ enabled: boolean
raycastTarget: boolean
```
-## InterestPoint — interface @experimental
-```
-x: number
-y: number
-z: number | undefined
-```
-
-## InterestPolicy — type @experimental
-```
-(view: InterestView) => ReadonlySet<Entity> | 'all'
-```
-
-## InterestProvider — interface @experimental
-```
-dispose: (() => void) | undefined
-prepare: (view: InterestProviderPrepareView) => PreparedInterest
-```
-
-## InterestProviderPrepareView — interface @experimental
-```
-entered: readonly number[] | undefined
-entities: Iterable<number>
-entityCount: number
-left: readonly number[] | undefined
-rechecked: readonly number[] | undefined
-world: World
-```
-
-## InterestProviderQueryView — interface @experimental
-```
-connectionId: number
-owned: readonly number[]
-```
-
-## InterestView — interface @experimental
-```
-candidates: readonly number[]
-connectionId: number
-owned: readonly number[] | undefined
-world: World
-```
-
## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
@@ -4991,19 +4944,6 @@ static prototype: MeleeAttacks
overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
```
-## MemoryTransport — class @experimental
-```
-delivery: "reliable-ordered"
-dropPending: () => void
-flush: (limit?: number) => void
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-pendingCount: number
-send: (data: string | ArrayBuffer) => void
-static new (options?: MemoryTransportOptions): MemoryTransport
-static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTransport]
-static prototype: MemoryTransport
-```
-
## 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; }
@@ -5114,28 +5054,6 @@ ResourceDef<MeshRendererAPI>
handle: number
```
-## MessageHandler — type @experimental
-```
-(payload: T) => void
-```
-
-## MessagePortLike — interface @experimental
-```
-close: (() => void) | undefined
-onmessage: ((event: { data: unknown; }) => void) | null
-postMessage: (data: unknown) => void
-```
-
-## MessagePortTransport — class @experimental
-```
-close: () => void
-delivery: "reliable-ordered"
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-send: (data: string | ArrayBuffer) => void
-static new (port: MessagePortLike | MessagePort): MessagePortTransport
-static prototype: MessagePortTransport
-```
-
## MigrationResult — interface @experimental
```
data: PrefabData
@@ -5288,51 +5206,6 @@ overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const @experimental
-```
-ResourceDef<NetSession>
-```
-
-## NetChannel — class @experimental
-```
-dispose: (reason?: string) => void
-handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
-on: <T = unknown>(type: string, handler: MessageHandler<T>) => () => void
-onBinary: (channel: number, handler: BinaryHandler) => () => void
-request: <Res = unknown, Req = unknown>(type: string, payload: Req, timeoutMs?: number) => Promise<Res>
-send: <T = unknown>(type: string, payload: T) => void
-sendBinary: (channel: number, payload: Uint8Array) => void
-static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
-static prototype: NetChannel
-```
-
-## NetChannelOptions — interface @experimental
-```
-requestTimeoutMs: number | undefined
-```
-
-## NetGhost — const @experimental
-```
-ComponentDef<{}>
-```
-
-## NetRoleKind — type @experimental
-```
-'offline' | 'server' | 'client'
-```
-
-## NetSession — class @experimental
-```
-client: ReplicationClient | null
-connect: (transport: ReliableOrderedTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
-role: NetRoleKind
-server: ReplicationServer | null
-startServer: () => ReplicationServer
-stop: () => void
-static new (app_: App): NetSession
-static prototype: NetSession
-```
-
## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -6276,19 +6149,6 @@ height: number
width: number
```
-## PredictionOptions — interface @experimental
-```
-apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
-maxPendingInputs: number | undefined
-smoothing: PredictionSmoothing | undefined
-```
-
-## PredictionSmoothing — interface @experimental
-```
-halfLife: number
-maxError: number | undefined
-```
-
## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
@@ -6388,12 +6248,6 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreparedInterest — interface @experimental
-```
-generation: number | undefined
-query: (view: InterestProviderQueryView) => ReadonlySet<Entity> | "all"
-```
-
## PresentedCameraView — const @beta
```
ResourceDef<CameraViewAPI>
@@ -6611,26 +6465,11 @@ TextureUploadDecision
ReadonlyMap<string, string>
```
-## REPLICATION_CHANNEL — const @experimental
-```
-1
-```
-
-## REPLICATION_PROTOCOL_VERSION — const @experimental
-```
-4
-```
-
## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface @experimental
-```
-position: ((world: World, entity: Entity) => InterestPoint | null) | undefined
-```
-
## ReadableWorld — type @experimental
```
Pick<World, 'valid' | 'has' | 'get'>
@@ -6806,88 +6645,6 @@ stable: boolean
why: string
```
-## Replicated — const @experimental
-```
-ComponentDef<ReplicatedData>
-```
-
-## ReplicatedData — interface @experimental
-```
-archetype: string
-netId: number
-owner: number
-```
-
-## ReplicationArchetype — type @experimental
-```
-(world: World, entity: Entity) => void
-```
-
-## ReplicationClient — class @experimental
-```
-@internal setFixedDelta: (dt: number) => void
-applyPending: () => void
-connect: (transport: ReliableOrderedTransport) => Promise<void>
-connected: boolean
-connectionId: number
-disconnect: () => void
-enablePrediction: (options: PredictionOptions) => void
-netIds: NetIds
-ownsEntity: (entity: Entity) => boolean
-predictionEnabled: boolean
-sampleInterpolation: (deltaTicks: number) => void
-sendInput: (actions: Record<string, unknown>) => void
-serverTick: number
-table: ReplicationTable
-static new (world: World, options?: ReplicationClientOptions): ReplicationClient
-static prototype: ReplicationClient
-```
-
-## ReplicationPlugin — class @experimental
-```
-build: (app: App) => void
-name: string
-static new (): ReplicationPlugin
-static prototype: ReplicationPlugin
-```
-
-## ReplicationServer — class @experimental
-```
-@internal deltaRowsSent: number
-@internal dirtyCandidates: number
-@internal entersSent: number
-@internal fullScans: number
-@internal journalReads: number
-@internal ownerScanVisits: number
-@internal payloadsBuilt: number
-@internal profileSample: boolean
-@internal samplePhases: Map<string, number>
-@internal viewerLinks: number
-@internal visibilityRecomputes: number
-attachConnection: (transport: ReliableOrderedTransport) => number
-beginTick: (fixedDelta: number) => void
-clientIds: number[]
-connectionCount: number
-detachConnection: (id: number) => void
-dispose: () => void
-inputOf: (connectionId: number) => ReplInputMsg | null
-leavesSent: number
-netIds: NetIds
-populationScans: number
-sample: (tick: number) => void
-setInterestPolicy: (policy: InterestPolicy | null) => void
-setInterestProvider: (provider: InterestProvider | null) => void
-table: ReplicationTable
-tickInputOf: (connectionId: number) => ReplInputMsg | null
-static new (world: World): ReplicationServer
-static prototype: ReplicationServer
-```
-
-## RequestHandler — type @experimental
-```
-(payload: Req) => Res | Promise<Res>
-```
-
## Res — function @public
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
@@ -10612,11 +10369,6 @@ Plugin
(): AchievementProvider
```
-## createMemoryTransportPair — function @experimental
-```
-(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
-```
-
## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
@@ -12042,16 +11794,6 @@ PrefabsPlugin
(rz: number, rw: number): number
```
-## radiusInterest — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestPolicy
-```
-
-## radiusInterestProvider — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestProvider
-```
-
## rankPickCandidates — function @experimental
```
<T>(candidates: ReadonlyArray<PickCandidate<T>>): T[]
@@ -12152,11 +11894,6 @@ PrefabsPlugin
(id: string, fn: PreSceneDrawCallback): void
```
-## registerReplicationArchetype — function @experimental
-```
-(key: string, build: ReplicationArchetype): void
-```
-
## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
@@ -12232,11 +11969,6 @@ PrefabsPlugin
(scope: SpeculationScope, body: (commands: CommandsInstance) => SpeculationOutcome): ReplayReport
```
-## replicationPlugin — const @experimental
-```
-ReplicationPlugin
-```
-
## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index b679e57f1..f74c166f8 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 · 1567 experimental · 3 deprecated
+Symbols: 115 public · 96 beta · 1532 experimental · 3 deprecated
## ABI_LAYOUT_HASH — const @experimental
```
@@ -1499,11 +1499,6 @@ p2x: number
p2y: number
```
-## BinaryHandler — type @experimental
-```
-(payload: Uint8Array) => void
-```
-
## Binding — type @public
```
| { kind: 'key'; code: string }
@@ -4306,48 +4301,6 @@ enabled: boolean
raycastTarget: boolean
```
-## InterestPoint — interface @experimental
-```
-x: number
-y: number
-z: number | undefined
-```
-
-## InterestPolicy — type @experimental
-```
-(view: InterestView) => ReadonlySet<Entity> | 'all'
-```
-
-## InterestProvider — interface @experimental
-```
-dispose: (() => void) | undefined
-prepare: (view: InterestProviderPrepareView) => PreparedInterest
-```
-
-## InterestProviderPrepareView — interface @experimental
-```
-entered: readonly number[] | undefined
-entities: Iterable<number>
-entityCount: number
-left: readonly number[] | undefined
-rechecked: readonly number[] | undefined
-world: World
-```
-
-## InterestProviderQueryView — interface @experimental
-```
-connectionId: number
-owned: readonly number[]
-```
-
-## InterestView — interface @experimental
-```
-candidates: readonly number[]
-connectionId: number
-owned: readonly number[] | undefined
-world: World
-```
-
## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
@@ -5004,19 +4957,6 @@ overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, la
resolveComponentHeap: (cppName: string) => ComponentHeapResolver | null
```
-## MemoryTransport — class @experimental
-```
-delivery: "reliable-ordered"
-dropPending: () => void
-flush: (limit?: number) => void
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-pendingCount: number
-send: (data: string | ArrayBuffer) => void
-static new (options?: MemoryTransportOptions): MemoryTransport
-static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTransport]
-static prototype: MemoryTransport
-```
-
## 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; }
@@ -5127,28 +5067,6 @@ ResourceDef<MeshRendererAPI>
handle: number
```
-## MessageHandler — type @experimental
-```
-(payload: T) => void
-```
-
-## MessagePortLike — interface @experimental
-```
-close: (() => void) | undefined
-onmessage: ((event: { data: unknown; }) => void) | null
-postMessage: (data: unknown) => void
-```
-
-## MessagePortTransport — class @experimental
-```
-close: () => void
-delivery: "reliable-ordered"
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-send: (data: string | ArrayBuffer) => void
-static new (port: MessagePortLike | MessagePort): MessagePortTransport
-static prototype: MessagePortTransport
-```
-
## MigrationResult — interface @experimental
```
data: PrefabData
@@ -5466,51 +5384,6 @@ overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const @experimental
-```
-ResourceDef<NetSession>
-```
-
-## NetChannel — class @experimental
-```
-dispose: (reason?: string) => void
-handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
-on: <T = unknown>(type: string, handler: MessageHandler<T>) => () => void
-onBinary: (channel: number, handler: BinaryHandler) => () => void
-request: <Res = unknown, Req = unknown>(type: string, payload: Req, timeoutMs?: number) => Promise<Res>
-send: <T = unknown>(type: string, payload: T) => void
-sendBinary: (channel: number, payload: Uint8Array) => void
-static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
-static prototype: NetChannel
-```
-
-## NetChannelOptions — interface @experimental
-```
-requestTimeoutMs: number | undefined
-```
-
-## NetGhost — const @experimental
-```
-ComponentDef<{}>
-```
-
-## NetRoleKind — type @experimental
-```
-'offline' | 'server' | 'client'
-```
-
-## NetSession — class @experimental
-```
-client: ReplicationClient | null
-connect: (transport: ReliableOrderedTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
-role: NetRoleKind
-server: ReplicationServer | null
-startServer: () => ReplicationServer
-stop: () => void
-static new (app_: App): NetSession
-static prototype: NetSession
-```
-
## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -6459,19 +6332,6 @@ height: number
width: number
```
-## PredictionOptions — interface @experimental
-```
-apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
-maxPendingInputs: number | undefined
-smoothing: PredictionSmoothing | undefined
-```
-
-## PredictionSmoothing — interface @experimental
-```
-halfLife: number
-maxError: number | undefined
-```
-
## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
@@ -6571,12 +6431,6 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreparedInterest — interface @experimental
-```
-generation: number | undefined
-query: (view: InterestProviderQueryView) => ReadonlySet<Entity> | "all"
-```
-
## PresentedCameraView — const @beta
```
ResourceDef<CameraViewAPI>
@@ -6799,16 +6653,6 @@ TextureUploadDecision
ReadonlyMap<string, string>
```
-## REPLICATION_CHANNEL — const @experimental
-```
-1
-```
-
-## REPLICATION_PROTOCOL_VERSION — const @experimental
-```
-4
-```
-
## RESOURCE_BINDINGS — const @experimental
```
{ readonly createTexture: "es_rm_createTextureEx"; readonly createTextureKTX2: "es_createTextureKTX2"; readonly releaseTexture: "es_rm_releaseTexture"; readonly registerTextureWithPath: "es_rm_registerTextureWithPath"; readonly getTextureDimensions: "es_getTextureDimensions"; }
@@ -6819,11 +6663,6 @@ ReadonlyMap<string, string>
ReadonlySet<string>
```
-## RadiusInterestOptions — interface @experimental
-```
-position: ((world: World, entity: Entity) => InterestPoint | null) | undefined
-```
-
## ReadableWorld — type @experimental
```
Pick<World, 'valid' | 'has' | 'get'>
@@ -6999,88 +6838,6 @@ stable: boolean
why: string
```
-## Replicated — const @experimental
-```
-ComponentDef<ReplicatedData>
-```
-
-## ReplicatedData — interface @experimental
-```
-archetype: string
-netId: number
-owner: number
-```
-
-## ReplicationArchetype — type @experimental
-```
-(world: World, entity: Entity) => void
-```
-
-## ReplicationClient — class @experimental
-```
-@internal setFixedDelta: (dt: number) => void
-applyPending: () => void
-connect: (transport: ReliableOrderedTransport) => Promise<void>
-connected: boolean
-connectionId: number
-disconnect: () => void
-enablePrediction: (options: PredictionOptions) => void
-netIds: NetIds
-ownsEntity: (entity: Entity) => boolean
-predictionEnabled: boolean
-sampleInterpolation: (deltaTicks: number) => void
-sendInput: (actions: Record<string, unknown>) => void
-serverTick: number
-table: ReplicationTable
-static new (world: World, options?: ReplicationClientOptions): ReplicationClient
-static prototype: ReplicationClient
-```
-
-## ReplicationPlugin — class @experimental
-```
-build: (app: App) => void
-name: string
-static new (): ReplicationPlugin
-static prototype: ReplicationPlugin
-```
-
-## ReplicationServer — class @experimental
-```
-@internal deltaRowsSent: number
-@internal dirtyCandidates: number
-@internal entersSent: number
-@internal fullScans: number
-@internal journalReads: number
-@internal ownerScanVisits: number
-@internal payloadsBuilt: number
-@internal profileSample: boolean
-@internal samplePhases: Map<string, number>
-@internal viewerLinks: number
-@internal visibilityRecomputes: number
-attachConnection: (transport: ReliableOrderedTransport) => number
-beginTick: (fixedDelta: number) => void
-clientIds: number[]
-connectionCount: number
-detachConnection: (id: number) => void
-dispose: () => void
-inputOf: (connectionId: number) => ReplInputMsg | null
-leavesSent: number
-netIds: NetIds
-populationScans: number
-sample: (tick: number) => void
-setInterestPolicy: (policy: InterestPolicy | null) => void
-setInterestProvider: (provider: InterestProvider | null) => void
-table: ReplicationTable
-tickInputOf: (connectionId: number) => ReplInputMsg | null
-static new (world: World): ReplicationServer
-static prototype: ReplicationServer
-```
-
-## RequestHandler — type @experimental
-```
-(payload: Req) => Res | Promise<Res>
-```
-
## Res — function @public
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
@@ -10825,11 +10582,6 @@ Plugin
(): AchievementProvider
```
-## createMemoryTransportPair — function @experimental
-```
-(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
-```
-
## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
@@ -12285,16 +12037,6 @@ PrefabsPlugin
(rz: number, rw: number): number
```
-## radiusInterest — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestPolicy
-```
-
-## radiusInterestProvider — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestProvider
-```
-
## rankPickCandidates — function @experimental
```
<T>(candidates: ReadonlyArray<PickCandidate<T>>): T[]
@@ -12395,11 +12137,6 @@ PrefabsPlugin
(id: string, fn: PreSceneDrawCallback): void
```
-## registerReplicationArchetype — function @experimental
-```
-(key: string, build: ReplicationArchetype): void
-```
-
## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
@@ -12475,11 +12212,6 @@ PrefabsPlugin
(scope: SpeculationScope, body: (commands: CommandsInstance) => SpeculationOutcome): ReplayReport
```
-## replicationPlugin — const @experimental
-```
-ReplicationPlugin
-```
-
## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index fdad5354c..a256a33b8 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 · 1547 experimental · 3 deprecated
+Symbols: 115 public · 93 beta · 1512 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1494,11 +1494,6 @@ p2x: number
p2y: number
```
-## BinaryHandler — type @experimental
-```
-(payload: Uint8Array) => void
-```
-
## Binding — type @public
```
| { kind: 'key'; code: string }
@@ -4293,48 +4288,6 @@ enabled: boolean
raycastTarget: boolean
```
-## InterestPoint — interface @experimental
-```
-x: number
-y: number
-z: number | undefined
-```
-
-## InterestPolicy — type @experimental
-```
-(view: InterestView) => ReadonlySet<Entity> | 'all'
-```
-
-## InterestProvider — interface @experimental
-```
-dispose: (() => void) | undefined
-prepare: (view: InterestProviderPrepareView) => PreparedInterest
-```
-
-## InterestProviderPrepareView — interface @experimental
-```
-entered: readonly number[] | undefined
-entities: Iterable<number>
-entityCount: number
-left: readonly number[] | undefined
-rechecked: readonly number[] | undefined
-world: World
-```
-
-## InterestProviderQueryView — interface @experimental
-```
-connectionId: number
-owned: readonly number[]
-```
-
-## InterestView — interface @experimental
-```
-candidates: readonly number[]
-connectionId: number
-owned: readonly number[] | undefined
-world: World
-```
-
## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
@@ -4986,19 +4939,6 @@ static prototype: MeleeAttacks
overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
```
-## MemoryTransport — class @experimental
-```
-delivery: "reliable-ordered"
-dropPending: () => void
-flush: (limit?: number) => void
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-pendingCount: number
-send: (data: string | ArrayBuffer) => void
-static new (options?: MemoryTransportOptions): MemoryTransport
-static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTransport]
-static prototype: MemoryTransport
-```
-
## 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; }
@@ -5109,28 +5049,6 @@ ResourceDef<MeshRendererAPI>
handle: number
```
-## MessageHandler — type @experimental
-```
-(payload: T) => void
-```
-
-## MessagePortLike — interface @experimental
-```
-close: (() => void) | undefined
-onmessage: ((event: { data: unknown; }) => void) | null
-postMessage: (data: unknown) => void
-```
-
-## MessagePortTransport — class @experimental
-```
-close: () => void
-delivery: "reliable-ordered"
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-send: (data: string | ArrayBuffer) => void
-static new (port: MessagePortLike | MessagePort): MessagePortTransport
-static prototype: MessagePortTransport
-```
-
## MigrationResult — interface @experimental
```
data: PrefabData
@@ -5283,51 +5201,6 @@ overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const @experimental
-```
-ResourceDef<NetSession>
-```
-
-## NetChannel — class @experimental
-```
-dispose: (reason?: string) => void
-handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
-on: <T = unknown>(type: string, handler: MessageHandler<T>) => () => void
-onBinary: (channel: number, handler: BinaryHandler) => () => void
-request: <Res = unknown, Req = unknown>(type: string, payload: Req, timeoutMs?: number) => Promise<Res>
-send: <T = unknown>(type: string, payload: T) => void
-sendBinary: (channel: number, payload: Uint8Array) => void
-static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
-static prototype: NetChannel
-```
-
-## NetChannelOptions — interface @experimental
-```
-requestTimeoutMs: number | undefined
-```
-
-## NetGhost — const @experimental
-```
-ComponentDef<{}>
-```
-
-## NetRoleKind — type @experimental
-```
-'offline' | 'server' | 'client'
-```
-
-## NetSession — class @experimental
-```
-client: ReplicationClient | null
-connect: (transport: ReliableOrderedTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
-role: NetRoleKind
-server: ReplicationServer | null
-startServer: () => ReplicationServer
-stop: () => void
-static new (app_: App): NetSession
-static prototype: NetSession
-```
-
## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -6271,19 +6144,6 @@ height: number
width: number
```
-## PredictionOptions — interface @experimental
-```
-apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
-maxPendingInputs: number | undefined
-smoothing: PredictionSmoothing | undefined
-```
-
-## PredictionSmoothing — interface @experimental
-```
-halfLife: number
-maxError: number | undefined
-```
-
## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
@@ -6383,12 +6243,6 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreparedInterest — interface @experimental
-```
-generation: number | undefined
-query: (view: InterestProviderQueryView) => ReadonlySet<Entity> | "all"
-```
-
## PresentedCameraView — const @beta
```
ResourceDef<CameraViewAPI>
@@ -6606,26 +6460,11 @@ TextureUploadDecision
ReadonlyMap<string, string>
```
-## REPLICATION_CHANNEL — const @experimental
-```
-1
-```
-
-## REPLICATION_PROTOCOL_VERSION — const @experimental
-```
-4
-```
-
## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface @experimental
-```
-position: ((world: World, entity: Entity) => InterestPoint | null) | undefined
-```
-
## ReadableWorld — type @experimental
```
Pick<World, 'valid' | 'has' | 'get'>
@@ -6801,88 +6640,6 @@ stable: boolean
why: string
```
-## Replicated — const @experimental
-```
-ComponentDef<ReplicatedData>
-```
-
-## ReplicatedData — interface @experimental
-```
-archetype: string
-netId: number
-owner: number
-```
-
-## ReplicationArchetype — type @experimental
-```
-(world: World, entity: Entity) => void
-```
-
-## ReplicationClient — class @experimental
-```
-@internal setFixedDelta: (dt: number) => void
-applyPending: () => void
-connect: (transport: ReliableOrderedTransport) => Promise<void>
-connected: boolean
-connectionId: number
-disconnect: () => void
-enablePrediction: (options: PredictionOptions) => void
-netIds: NetIds
-ownsEntity: (entity: Entity) => boolean
-predictionEnabled: boolean
-sampleInterpolation: (deltaTicks: number) => void
-sendInput: (actions: Record<string, unknown>) => void
-serverTick: number
-table: ReplicationTable
-static new (world: World, options?: ReplicationClientOptions): ReplicationClient
-static prototype: ReplicationClient
-```
-
-## ReplicationPlugin — class @experimental
-```
-build: (app: App) => void
-name: string
-static new (): ReplicationPlugin
-static prototype: ReplicationPlugin
-```
-
-## ReplicationServer — class @experimental
-```
-@internal deltaRowsSent: number
-@internal dirtyCandidates: number
-@internal entersSent: number
-@internal fullScans: number
-@internal journalReads: number
-@internal ownerScanVisits: number
-@internal payloadsBuilt: number
-@internal profileSample: boolean
-@internal samplePhases: Map<string, number>
-@internal viewerLinks: number
-@internal visibilityRecomputes: number
-attachConnection: (transport: ReliableOrderedTransport) => number
-beginTick: (fixedDelta: number) => void
-clientIds: number[]
-connectionCount: number
-detachConnection: (id: number) => void
-dispose: () => void
-inputOf: (connectionId: number) => ReplInputMsg | null
-leavesSent: number
-netIds: NetIds
-populationScans: number
-sample: (tick: number) => void
-setInterestPolicy: (policy: InterestPolicy | null) => void
-setInterestProvider: (provider: InterestProvider | null) => void
-table: ReplicationTable
-tickInputOf: (connectionId: number) => ReplInputMsg | null
-static new (world: World): ReplicationServer
-static prototype: ReplicationServer
-```
-
-## RequestHandler — type @experimental
-```
-(payload: Req) => Res | Promise<Res>
-```
-
## Res — function @public
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
@@ -10607,11 +10364,6 @@ Plugin
(): AchievementProvider
```
-## createMemoryTransportPair — function @experimental
-```
-(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
-```
-
## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
@@ -12047,16 +11799,6 @@ PrefabsPlugin
(rz: number, rw: number): number
```
-## radiusInterest — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestPolicy
-```
-
-## radiusInterestProvider — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestProvider
-```
-
## rankPickCandidates — function @experimental
```
<T>(candidates: ReadonlyArray<PickCandidate<T>>): T[]
@@ -12157,11 +11899,6 @@ PrefabsPlugin
(id: string, fn: PreSceneDrawCallback): void
```
-## registerReplicationArchetype — function @experimental
-```
-(key: string, build: ReplicationArchetype): void
-```
-
## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
@@ -12237,11 +11974,6 @@ PrefabsPlugin
(scope: SpeculationScope, body: (commands: CommandsInstance) => SpeculationOutcome): ReplayReport
```
-## replicationPlugin — const @experimental
-```
-ReplicationPlugin
-```
-
## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index 1acc4ad1a..2402b3f9d 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 · 1569 experimental · 3 deprecated
+Symbols: 115 public · 91 beta · 1534 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1494,11 +1494,6 @@ p2x: number
p2y: number
```
-## BinaryHandler — type @experimental
-```
-(payload: Uint8Array) => void
-```
-
## Binding — type @public
```
| { kind: 'key'; code: string }
@@ -4293,48 +4288,6 @@ enabled: boolean
raycastTarget: boolean
```
-## InterestPoint — interface @experimental
-```
-x: number
-y: number
-z: number | undefined
-```
-
-## InterestPolicy — type @experimental
-```
-(view: InterestView) => ReadonlySet<Entity> | 'all'
-```
-
-## InterestProvider — interface @experimental
-```
-dispose: (() => void) | undefined
-prepare: (view: InterestProviderPrepareView) => PreparedInterest
-```
-
-## InterestProviderPrepareView — interface @experimental
-```
-entered: readonly number[] | undefined
-entities: Iterable<number>
-entityCount: number
-left: readonly number[] | undefined
-rechecked: readonly number[] | undefined
-world: World
-```
-
-## InterestProviderQueryView — interface @experimental
-```
-connectionId: number
-owned: readonly number[]
-```
-
-## InterestView — interface @experimental
-```
-candidates: readonly number[]
-connectionId: number
-owned: readonly number[] | undefined
-world: World
-```
-
## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
@@ -4986,19 +4939,6 @@ static prototype: MeleeAttacks
overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
```
-## MemoryTransport — class @experimental
-```
-delivery: "reliable-ordered"
-dropPending: () => void
-flush: (limit?: number) => void
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-pendingCount: number
-send: (data: string | ArrayBuffer) => void
-static new (options?: MemoryTransportOptions): MemoryTransport
-static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTransport]
-static prototype: MemoryTransport
-```
-
## 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; }
@@ -5109,28 +5049,6 @@ ResourceDef<MeshRendererAPI>
handle: number
```
-## MessageHandler — type @experimental
-```
-(payload: T) => void
-```
-
-## MessagePortLike — interface @experimental
-```
-close: (() => void) | undefined
-onmessage: ((event: { data: unknown; }) => void) | null
-postMessage: (data: unknown) => void
-```
-
-## MessagePortTransport — class @experimental
-```
-close: () => void
-delivery: "reliable-ordered"
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-send: (data: string | ArrayBuffer) => void
-static new (port: MessagePortLike | MessagePort): MessagePortTransport
-static prototype: MessagePortTransport
-```
-
## MigrationResult — interface @experimental
```
data: PrefabData
@@ -5534,51 +5452,6 @@ overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const @experimental
-```
-ResourceDef<NetSession>
-```
-
-## NetChannel — class @experimental
-```
-dispose: (reason?: string) => void
-handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
-on: <T = unknown>(type: string, handler: MessageHandler<T>) => () => void
-onBinary: (channel: number, handler: BinaryHandler) => () => void
-request: <Res = unknown, Req = unknown>(type: string, payload: Req, timeoutMs?: number) => Promise<Res>
-send: <T = unknown>(type: string, payload: T) => void
-sendBinary: (channel: number, payload: Uint8Array) => void
-static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
-static prototype: NetChannel
-```
-
-## NetChannelOptions — interface @experimental
-```
-requestTimeoutMs: number | undefined
-```
-
-## NetGhost — const @experimental
-```
-ComponentDef<{}>
-```
-
-## NetRoleKind — type @experimental
-```
-'offline' | 'server' | 'client'
-```
-
-## NetSession — class @experimental
-```
-client: ReplicationClient | null
-connect: (transport: ReliableOrderedTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
-role: NetRoleKind
-server: ReplicationServer | null
-startServer: () => ReplicationServer
-stop: () => void
-static new (app_: App): NetSession
-static prototype: NetSession
-```
-
## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -6522,19 +6395,6 @@ height: number
width: number
```
-## PredictionOptions — interface @experimental
-```
-apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
-maxPendingInputs: number | undefined
-smoothing: PredictionSmoothing | undefined
-```
-
-## PredictionSmoothing — interface @experimental
-```
-halfLife: number
-maxError: number | undefined
-```
-
## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
@@ -6634,12 +6494,6 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreparedInterest — interface @experimental
-```
-generation: number | undefined
-query: (view: InterestProviderQueryView) => ReadonlySet<Entity> | "all"
-```
-
## PresentedCameraView — const @beta
```
ResourceDef<CameraViewAPI>
@@ -6857,26 +6711,11 @@ TextureUploadDecision
ReadonlyMap<string, string>
```
-## REPLICATION_CHANNEL — const @experimental
-```
-1
-```
-
-## REPLICATION_PROTOCOL_VERSION — const @experimental
-```
-4
-```
-
## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface @experimental
-```
-position: ((world: World, entity: Entity) => InterestPoint | null) | undefined
-```
-
## ReadableWorld — type @experimental
```
Pick<World, 'valid' | 'has' | 'get'>
@@ -7052,88 +6891,6 @@ stable: boolean
why: string
```
-## Replicated — const @experimental
-```
-ComponentDef<ReplicatedData>
-```
-
-## ReplicatedData — interface @experimental
-```
-archetype: string
-netId: number
-owner: number
-```
-
-## ReplicationArchetype — type @experimental
-```
-(world: World, entity: Entity) => void
-```
-
-## ReplicationClient — class @experimental
-```
-@internal setFixedDelta: (dt: number) => void
-applyPending: () => void
-connect: (transport: ReliableOrderedTransport) => Promise<void>
-connected: boolean
-connectionId: number
-disconnect: () => void
-enablePrediction: (options: PredictionOptions) => void
-netIds: NetIds
-ownsEntity: (entity: Entity) => boolean
-predictionEnabled: boolean
-sampleInterpolation: (deltaTicks: number) => void
-sendInput: (actions: Record<string, unknown>) => void
-serverTick: number
-table: ReplicationTable
-static new (world: World, options?: ReplicationClientOptions): ReplicationClient
-static prototype: ReplicationClient
-```
-
-## ReplicationPlugin — class @experimental
-```
-build: (app: App) => void
-name: string
-static new (): ReplicationPlugin
-static prototype: ReplicationPlugin
-```
-
-## ReplicationServer — class @experimental
-```
-@internal deltaRowsSent: number
-@internal dirtyCandidates: number
-@internal entersSent: number
-@internal fullScans: number
-@internal journalReads: number
-@internal ownerScanVisits: number
-@internal payloadsBuilt: number
-@internal profileSample: boolean
-@internal samplePhases: Map<string, number>
-@internal viewerLinks: number
-@internal visibilityRecomputes: number
-attachConnection: (transport: ReliableOrderedTransport) => number
-beginTick: (fixedDelta: number) => void
-clientIds: number[]
-connectionCount: number
-detachConnection: (id: number) => void
-dispose: () => void
-inputOf: (connectionId: number) => ReplInputMsg | null
-leavesSent: number
-netIds: NetIds
-populationScans: number
-sample: (tick: number) => void
-setInterestPolicy: (policy: InterestPolicy | null) => void
-setInterestProvider: (provider: InterestProvider | null) => void
-table: ReplicationTable
-tickInputOf: (connectionId: number) => ReplInputMsg | null
-static new (world: World): ReplicationServer
-static prototype: ReplicationServer
-```
-
-## RequestHandler — type @experimental
-```
-(payload: Req) => Res | Promise<Res>
-```
-
## Res — function @public
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
@@ -10864,11 +10621,6 @@ Plugin
(): AchievementProvider
```
-## createMemoryTransportPair — function @experimental
-```
-(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
-```
-
## createMiniGameSideModuleHost — function @experimental
```
(factories: MiniGameSideModuleFactories): SideModuleHost
@@ -12309,16 +12061,6 @@ PrefabsPlugin
(rz: number, rw: number): number
```
-## radiusInterest — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestPolicy
-```
-
-## radiusInterestProvider — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestProvider
-```
-
## rankPickCandidates — function @experimental
```
<T>(candidates: ReadonlyArray<PickCandidate<T>>): T[]
@@ -12419,11 +12161,6 @@ PrefabsPlugin
(id: string, fn: PreSceneDrawCallback): void
```
-## registerReplicationArchetype — function @experimental
-```
-(key: string, build: ReplicationArchetype): void
-```
-
## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
@@ -12499,11 +12236,6 @@ PrefabsPlugin
(scope: SpeculationScope, body: (commands: CommandsInstance) => SpeculationOutcome): ReplayReport
```
-## replicationPlugin — const @experimental
-```
-ReplicationPlugin
-```
-
## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
diff --git a/sdk/etc/replication.api.md b/sdk/etc/replication.api.md
new file mode 100644
index 000000000..8f7eef52f
--- /dev/null
+++ b/sdk/etc/replication.api.md
@@ -0,0 +1,508 @@
+# API surface — esengine/replication
+
+<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
+Symbols: 0 public · 0 beta · 68 experimental · 0 deprecated
+
+## BinaryHandler — type @experimental
+```
+(payload: Uint8Array) => void
+```
+
+## ByteReader — class @experimental
+```
+f32: () => number
+remaining: number
+string: () => string
+u16: () => number
+u32: () => number
+u8: () => number
+static new (data: Uint8Array): ByteReader
+static prototype: ByteReader
+```
+
+## ByteWriter — class @experimental
+```
+f32: (v: number) => void
+finish: () => Uint8Array
+length: number
+patchU16: (offset: number, v: number) => void
+string: (s: string) => void
+u16: (v: number) => void
+u32: (v: number) => void
+u8: (v: number) => void
+static new (initialCapacity?: number): ByteWriter
+static prototype: ByteWriter
+```
+
+## ComponentBuffer — class @experimental
+```
+byField: Map<number, FieldSeries>
+push: (fieldIndex: number, tick: number, value: unknown) => void
+static new (): ComponentBuffer
+static prototype: ComponentBuffer
+```
+
+## EntityRefMap — interface @experimental
+```
+fromWire: (netId: number) => number
+toWire: (entity: number) => number
+```
+
+## FieldShape — type @experimental
+```
+| { kind: 'f32' }
+ | { kind: 'bool' }
+ | { kind: 'string' }
+ | { kind: 'entity' }
+ | { kind: 'object'; keys: string[]; shapes: FieldShape[] }
+ | { kind: 'json' }
+```
+
+## FrameWriter — class @experimental
+```
+entry: (netId: number, table: ReplicationTableEntry, fieldMask: number, data: Record<string, unknown>, refs?: EntityRefMap) => void
+entryCount: number
+finish: () => Uint8Array
+static new (tick: number): FrameWriter
+static prototype: FrameWriter
+```
+
+## InterestPoint — interface @experimental
+```
+x: number
+y: number
+z: number | undefined
+```
+
+## InterestPolicy — type @experimental
+```
+(view: InterestView) => ReadonlySet<Entity> | 'all'
+```
+
+## InterestProvider — interface @experimental
+```
+dispose: (() => void) | undefined
+prepare: (view: InterestProviderPrepareView) => PreparedInterest
+```
+
+## InterestProviderPrepareView — interface @experimental
+```
+entered: readonly number[] | undefined
+entities: Iterable<number>
+entityCount: number
+left: readonly number[] | undefined
+rechecked: readonly number[] | undefined
+world: World
+```
+
+## InterestProviderQueryView — interface @experimental
+```
+connectionId: number
+owned: readonly number[]
+```
+
+## InterestView — interface @experimental
+```
+candidates: readonly number[]
+connectionId: number
+owned: readonly number[] | undefined
+world: World
+```
+
+## InterpolationState — class @experimental
+```
+advance: (deltaTicks: number) => number
+buffers: Map<number, Map<number, ComponentBuffer>>
+delayTicks: number
+drop: (netId: number) => void
+dropComponent: (netId: number, componentId: number) => void
+newestTick: number
+push: (netId: number, componentId: number, fieldIndex: number, tick: number, value: unknown) => void
+static new (delayTicks: number): InterpolationState
+static prototype: InterpolationState
+```
+
+## MemoryTransport — class @experimental
+```
+delivery: "reliable-ordered"
+dropPending: () => void
+flush: (limit?: number) => void
+on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
+pendingCount: number
+send: (data: string | ArrayBuffer) => void
+static new (options?: MemoryTransportOptions): MemoryTransport
+static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTransport]
+static prototype: MemoryTransport
+```
+
+## MessageHandler — type @experimental
+```
+(payload: T) => void
+```
+
+## MessagePortLike — interface @experimental
+```
+close: (() => void) | undefined
+onmessage: ((event: { data: unknown; }) => void) | null
+postMessage: (data: unknown) => void
+```
+
+## MessagePortTransport — class @experimental
+```
+close: () => void
+delivery: "reliable-ordered"
+on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
+send: (data: string | ArrayBuffer) => void
+static new (port: MessagePortLike | MessagePort): MessagePortTransport
+static prototype: MessagePortTransport
+```
+
+## Net — const @experimental
+```
+ResourceDef<NetSession>
+```
+
+## NetChannel — class @experimental
+```
+dispose: (reason?: string) => void
+handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
+on: <T = unknown>(type: string, handler: MessageHandler<T>) => () => void
+onBinary: (channel: number, handler: BinaryHandler) => () => void
+request: <Res = unknown, Req = unknown>(type: string, payload: Req, timeoutMs?: number) => Promise<Res>
+send: <T = unknown>(type: string, payload: T) => void
+sendBinary: (channel: number, payload: Uint8Array) => void
+static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
+static prototype: NetChannel
+```
+
+## NetChannelOptions — interface @experimental
+```
+requestTimeoutMs: number | undefined
+```
+
+## NetGhost — const @experimental
+```
+ComponentDef<{}>
+```
+
+## NetIds — class @experimental
+```
+allocate: () => number
+clear: () => void
+entityOf: (netId: number) => Entity | undefined
+netIdOf: (entity: Entity) => number | undefined
+register: (netId: number, entity: Entity) => void
+size: number
+unregister: (netId: number) => void
+unregisterEntity: (entity: Entity) => void
+static new (): NetIds
+static prototype: NetIds
+```
+
+## NetRoleKind — type @experimental
+```
+'offline' | 'server' | 'client'
+```
+
+## NetSession — class @experimental
+```
+client: ReplicationClient | null
+connect: (transport: ReliableOrderedTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
+role: NetRoleKind
+server: ReplicationServer | null
+startServer: () => ReplicationServer
+stop: () => void
+static new (app_: App): NetSession
+static prototype: NetSession
+```
+
+## PredictionOptions — interface @experimental
+```
+apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
+maxPendingInputs: number | undefined
+smoothing: PredictionSmoothing | undefined
+```
+
+## PredictionSmoothing — interface @experimental
+```
+halfLife: number
+maxError: number | undefined
+```
+
+## PreparedInterest — interface @experimental
+```
+generation: number | undefined
+query: (view: InterestProviderQueryView) => ReadonlySet<Entity> | "all"
+```
+
+## REPLICATION_CHANNEL — const @experimental
+```
+1
+```
+
+## REPLICATION_PROTOCOL_VERSION — const @experimental
+```
+4
+```
+
+## RadiusInterestOptions — interface @experimental
+```
+position: ((world: World, entity: Entity) => InterestPoint | null) | undefined
+```
+
+## ReplAckMsg — interface @experimental
+```
+seq: number
+tick: number
+```
+
+## ReplComponentRemoveBatch — interface @experimental
+```
+entries: { netId: number; componentIds: number[]; }[]
+tick: number
+```
+
+## ReplComponentSchema — interface @experimental
+```
+fields: string[]
+name: string
+shapes: string[]
+```
+
+## ReplDespawnBatch — interface @experimental
+```
+netIds: number[]
+tick: number
+```
+
+## ReplHelloRequest — interface @experimental
+```
+abiHash: string
+components: ReplComponentSchema[]
+protocolVersion: number
+```
+
+## ReplHelloResponse — type @experimental
+```
+ReplHelloOk | ReplHelloError
+```
+
+## ReplInputMsg — interface @experimental
+```
+actions: Record<string, unknown>
+seq: number
+```
+
+## ReplMsg — const @experimental
+```
+{ readonly hello: "repl:hello"; readonly spawn: "repl:spawn"; readonly despawn: "repl:despawn"; readonly componentRemove: "repl:crm"; readonly input: "repl:input"; readonly ack: "repl:ack"; }
+```
+
+## ReplSpawnBatch — interface @experimental
+```
+entities: ReplSpawnEntity[]
+tick: number
+```
+
+## ReplSpawnEntity — interface @experimental
+```
+archetype: string
+baseline: SceneComponentData[]
+name: string
+netId: number
+owner: number
+parentNetId: number
+```
+
+## Replicated — const @experimental
+```
+ComponentDef<ReplicatedData>
+```
+
+## ReplicatedData — interface @experimental
+```
+archetype: string
+netId: number
+owner: number
+```
+
+## ReplicationArchetype — type @experimental
+```
+(world: World, entity: Entity) => void
+```
+
+## ReplicationClient — class @experimental
+```
+@internal setFixedDelta: (dt: number) => void
+applyPending: () => void
+connect: (transport: ReliableOrderedTransport) => Promise<void>
+connected: boolean
+connectionId: number
+disconnect: () => void
+enablePrediction: (options: PredictionOptions) => void
+netIds: NetIds
+ownsEntity: (entity: Entity) => boolean
+predictionEnabled: boolean
+sampleInterpolation: (deltaTicks: number) => void
+sendInput: (actions: Record<string, unknown>) => void
+serverTick: number
+table: ReplicationTable
+static new (world: World, options?: ReplicationClientOptions): ReplicationClient
+static prototype: ReplicationClient
+```
+
+## ReplicationClientOptions — interface @experimental
+```
+interpolationDelayTicks: number | undefined
+prediction: PredictionOptions | undefined
+```
+
+## ReplicationPlugin — class @experimental
+```
+build: (app: App) => void
+name: string
+static new (): ReplicationPlugin
+static prototype: ReplicationPlugin
+```
+
+## ReplicationServer — class @experimental
+```
+@internal deltaRowsSent: number
+@internal dirtyCandidates: number
+@internal entersSent: number
+@internal fullScans: number
+@internal journalReads: number
+@internal ownerScanVisits: number
+@internal payloadsBuilt: number
+@internal profileSample: boolean
+@internal samplePhases: Map<string, number>
+@internal viewerLinks: number
+@internal visibilityRecomputes: number
+attachConnection: (transport: ReliableOrderedTransport) => number
+beginTick: (fixedDelta: number) => void
+clientIds: number[]
+connectionCount: number
+detachConnection: (id: number) => void
+dispose: () => void
+inputOf: (connectionId: number) => ReplInputMsg | null
+leavesSent: number
+netIds: NetIds
+populationScans: number
+sample: (tick: number) => void
+setInterestPolicy: (policy: InterestPolicy | null) => void
+setInterestProvider: (provider: InterestProvider | null) => void
+table: ReplicationTable
+tickInputOf: (connectionId: number) => ReplInputMsg | null
+static new (world: World): ReplicationServer
+static prototype: ReplicationServer
+```
+
+## ReplicationTable — interface @experimental
+```
+byName: Map<string, ReplicationTableEntry>
+entries: ReplicationTableEntry[]
+```
+
+## ReplicationTableEntry — interface @experimental
+```
+def: AnyComponentDef
+fields: string[]
+id: number
+name: string
+shapes: FieldShape[]
+```
+
+## RequestHandler — type @experimental
+```
+(payload: Req) => Res | Promise<Res>
+```
+
+## StateEntry — interface @experimental
+```
+componentId: number
+fieldMask: number
+netId: number
+values: unknown[]
+```
+
+## StateFrame — interface @experimental
+```
+entries: StateEntry[]
+tick: number
+```
+
+## buildReplicationTable — function @experimental
+```
+(): ReplicationTable
+```
+
+## cloneValue — function @experimental
+```
+<T>(v: T): T
+```
+
+## createMemoryTransportPair — function @experimental
+```
+(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
+```
+
+## decodeStateFrame — function @experimental
+```
+(payload: Uint8Array, table: ReplicationTable, refs?: EntityRefMap): StateFrame
+```
+
+## decodeValue — function @experimental
+```
+(r: ByteReader, shape: FieldShape, refs?: EntityRefMap): unknown
+```
+
+## diffSchemas — function @experimental
+```
+(mine: ReplComponentSchema[], theirs: ReplComponentSchema[]): string | null
+```
+
+## encodeValue — function @experimental
+```
+(w: ByteWriter, shape: FieldShape, value: unknown, refs?: EntityRefMap): void
+```
+
+## lerpValue — function @experimental
+```
+(shape: FieldShape, a: unknown, b: unknown, t: number): unknown
+```
+
+## predictionReplays — function @experimental
+```
+(scope: SpeculationScope, prediction: PredictionOptions, entity: Entity, actions: Record<string, unknown>, dt: number): ReplayReport
+```
+
+## radiusInterest — function @experimental
+```
+(radius: number, options?: RadiusInterestOptions): InterestPolicy
+```
+
+## radiusInterestProvider — function @experimental
+```
+(radius: number, options?: RadiusInterestOptions): InterestProvider
+```
+
+## registerReplicationArchetype — function @experimental
+```
+(key: string, build: ReplicationArchetype): void
+```
+
+## replicationPlugin — const @experimental
+```
+ReplicationPlugin
+```
+
+## shapeSignature — function @experimental
+```
+(shape: FieldShape): string
+```
+
+## tableSchemas — function @experimental
+```
+(table: ReplicationTable): ReplComponentSchema[]
+```
+
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index c83f5d17d..76429a0f9 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 · 1560 experimental · 3 deprecated
+Symbols: 115 public · 91 beta · 1525 experimental · 3 deprecated
## ANCHOR_AXES — const @experimental
```
@@ -1494,11 +1494,6 @@ p2x: number
p2y: number
```
-## BinaryHandler — type @experimental
-```
-(payload: Uint8Array) => void
-```
-
## Binding — type @public
```
| { kind: 'key'; code: string }
@@ -4300,48 +4295,6 @@ enabled: boolean
raycastTarget: boolean
```
-## InterestPoint — interface @experimental
-```
-x: number
-y: number
-z: number | undefined
-```
-
-## InterestPolicy — type @experimental
-```
-(view: InterestView) => ReadonlySet<Entity> | 'all'
-```
-
-## InterestProvider — interface @experimental
-```
-dispose: (() => void) | undefined
-prepare: (view: InterestProviderPrepareView) => PreparedInterest
-```
-
-## InterestProviderPrepareView — interface @experimental
-```
-entered: readonly number[] | undefined
-entities: Iterable<number>
-entityCount: number
-left: readonly number[] | undefined
-rechecked: readonly number[] | undefined
-world: World
-```
-
-## InterestProviderQueryView — interface @experimental
-```
-connectionId: number
-owned: readonly number[]
-```
-
-## InterestView — interface @experimental
-```
-candidates: readonly number[]
-connectionId: number
-owned: readonly number[] | undefined
-world: World
-```
-
## InterpType — type @experimental
```
(typeof InterpType)[keyof typeof InterpType]
@@ -4993,19 +4946,6 @@ static prototype: MeleeAttacks
overlapSphere: (centre: { x: number; y: number; z: number; }, radius: number, layerMask?: number) => readonly Overlap3DHit[]
```
-## MemoryTransport — class @experimental
-```
-delivery: "reliable-ordered"
-dropPending: () => void
-flush: (limit?: number) => void
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-pendingCount: number
-send: (data: string | ArrayBuffer) => void
-static new (options?: MemoryTransportOptions): MemoryTransport
-static pair: (options?: MemoryTransportOptions) => [MemoryTransport, MemoryTransport]
-static prototype: MemoryTransport
-```
-
## 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; }
@@ -5116,28 +5056,6 @@ ResourceDef<MeshRendererAPI>
handle: number
```
-## MessageHandler — type @experimental
-```
-(payload: T) => void
-```
-
-## MessagePortLike — interface @experimental
-```
-close: (() => void) | undefined
-onmessage: ((event: { data: unknown; }) => void) | null
-postMessage: (data: unknown) => void
-```
-
-## MessagePortTransport — class @experimental
-```
-close: () => void
-delivery: "reliable-ordered"
-on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
-send: (data: string | ArrayBuffer) => void
-static new (port: MessagePortLike | MessagePort): MessagePortTransport
-static prototype: MessagePortTransport
-```
-
## MigrationResult — interface @experimental
```
data: PrefabData
@@ -5290,51 +5208,6 @@ overrides: PrefabOverride[]
prefabPath: string
```
-## Net — const @experimental
-```
-ResourceDef<NetSession>
-```
-
-## NetChannel — class @experimental
-```
-dispose: (reason?: string) => void
-handle: <Req = unknown, Res = unknown>(type: string, handler: RequestHandler<Req, Res>) => () => void
-on: <T = unknown>(type: string, handler: MessageHandler<T>) => () => void
-onBinary: (channel: number, handler: BinaryHandler) => () => void
-request: <Res = unknown, Req = unknown>(type: string, payload: Req, timeoutMs?: number) => Promise<Res>
-send: <T = unknown>(type: string, payload: T) => void
-sendBinary: (channel: number, payload: Uint8Array) => void
-static new (transport: NetTransport, opts?: NetChannelOptions): NetChannel
-static prototype: NetChannel
-```
-
-## NetChannelOptions — interface @experimental
-```
-requestTimeoutMs: number | undefined
-```
-
-## NetGhost — const @experimental
-```
-ComponentDef<{}>
-```
-
-## NetRoleKind — type @experimental
-```
-'offline' | 'server' | 'client'
-```
-
-## NetSession — class @experimental
-```
-client: ReplicationClient | null
-connect: (transport: ReliableOrderedTransport, options?: ReplicationClientOptions) => Promise<ReplicationClient>
-role: NetRoleKind
-server: ReplicationServer | null
-startServer: () => ReplicationServer
-stop: () => void
-static new (app_: App): NetSession
-static prototype: NetSession
-```
-
## NetTransport — interface @experimental
```
on: (event: "message", handler: (data: string | ArrayBuffer) => void) => () => void
@@ -6278,19 +6151,6 @@ height: number
width: number
```
-## PredictionOptions — interface @experimental
-```
-apply: (world: World, entity: Entity, actions: Record<string, unknown>, dt: number) => void
-maxPendingInputs: number | undefined
-smoothing: PredictionSmoothing | undefined
-```
-
-## PredictionSmoothing — interface @experimental
-```
-halfLife: number
-maxError: number | undefined
-```
-
## PrefabComponentData — interface @experimental
```
data: Record<string, unknown>
@@ -6390,12 +6250,6 @@ static new (): PrefabsPlugin
static prototype: PrefabsPlugin
```
-## PreparedInterest — interface @experimental
-```
-generation: number | undefined
-query: (view: InterestProviderQueryView) => ReadonlySet<Entity> | "all"
-```
-
## PresentedCameraView — const @beta
```
ResourceDef<CameraViewAPI>
@@ -6613,26 +6467,11 @@ TextureUploadDecision
ReadonlyMap<string, string>
```
-## REPLICATION_CHANNEL — const @experimental
-```
-1
-```
-
-## REPLICATION_PROTOCOL_VERSION — const @experimental
-```
-4
-```
-
## RETIRED_COMPONENT_TYPES — const @experimental
```
ReadonlySet<string>
```
-## RadiusInterestOptions — interface @experimental
-```
-position: ((world: World, entity: Entity) => InterestPoint | null) | undefined
-```
-
## ReadableWorld — type @experimental
```
Pick<World, 'valid' | 'has' | 'get'>
@@ -6808,88 +6647,6 @@ stable: boolean
why: string
```
-## Replicated — const @experimental
-```
-ComponentDef<ReplicatedData>
-```
-
-## ReplicatedData — interface @experimental
-```
-archetype: string
-netId: number
-owner: number
-```
-
-## ReplicationArchetype — type @experimental
-```
-(world: World, entity: Entity) => void
-```
-
-## ReplicationClient — class @experimental
-```
-@internal setFixedDelta: (dt: number) => void
-applyPending: () => void
-connect: (transport: ReliableOrderedTransport) => Promise<void>
-connected: boolean
-connectionId: number
-disconnect: () => void
-enablePrediction: (options: PredictionOptions) => void
-netIds: NetIds
-ownsEntity: (entity: Entity) => boolean
-predictionEnabled: boolean
-sampleInterpolation: (deltaTicks: number) => void
-sendInput: (actions: Record<string, unknown>) => void
-serverTick: number
-table: ReplicationTable
-static new (world: World, options?: ReplicationClientOptions): ReplicationClient
-static prototype: ReplicationClient
-```
-
-## ReplicationPlugin — class @experimental
-```
-build: (app: App) => void
-name: string
-static new (): ReplicationPlugin
-static prototype: ReplicationPlugin
-```
-
-## ReplicationServer — class @experimental
-```
-@internal deltaRowsSent: number
-@internal dirtyCandidates: number
-@internal entersSent: number
-@internal fullScans: number
-@internal journalReads: number
-@internal ownerScanVisits: number
-@internal payloadsBuilt: number
-@internal profileSample: boolean
-@internal samplePhases: Map<string, number>
-@internal viewerLinks: number
-@internal visibilityRecomputes: number
-attachConnection: (transport: ReliableOrderedTransport) => number
-beginTick: (fixedDelta: number) => void
-clientIds: number[]
-connectionCount: number
-detachConnection: (id: number) => void
-dispose: () => void
-inputOf: (connectionId: number) => ReplInputMsg | null
-leavesSent: number
-netIds: NetIds
-populationScans: number
-sample: (tick: number) => void
-setInterestPolicy: (policy: InterestPolicy | null) => void
-setInterestProvider: (provider: InterestProvider | null) => void
-table: ReplicationTable
-tickInputOf: (connectionId: number) => ReplInputMsg | null
-static new (world: World): ReplicationServer
-static prototype: ReplicationServer
-```
-
-## RequestHandler — type @experimental
-```
-(payload: Req) => Res | Promise<Res>
-```
-
## Res — function @public
```
<T>(resource: ResourceDef<T>): ResDescriptor<T>
@@ -10635,11 +10392,6 @@ Plugin
(): AchievementProvider
```
-## createMemoryTransportPair — function @experimental
-```
-(options?: MemoryTransportOptions): [MemoryTransport, MemoryTransport]
-```
-
## createMockAdProvider — function @experimental
```
(options?: MockAdProviderOptions): AdProvider
@@ -12075,16 +11827,6 @@ PrefabsPlugin
(rz: number, rw: number): number
```
-## radiusInterest — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestPolicy
-```
-
-## radiusInterestProvider — function @experimental
-```
-(radius: number, options?: RadiusInterestOptions): InterestProvider
-```
-
## rankPickCandidates — function @experimental
```
<T>(candidates: ReadonlyArray<PickCandidate<T>>): T[]
@@ -12185,11 +11927,6 @@ PrefabsPlugin
(id: string, fn: PreSceneDrawCallback): void
```
-## registerReplicationArchetype — function @experimental
-```
-(key: string, build: ReplicationArchetype): void
-```
-
## registerSceneComponentCodec — function @experimental
```
(type: string, codec: SceneComponentCodec): void
@@ -12265,11 +12002,6 @@ PrefabsPlugin
(scope: SpeculationScope, body: (commands: CommandsInstance) => SpeculationOutcome): ReplayReport
```
-## replicationPlugin — const @experimental
-```
-ReplicationPlugin
-```
-
## reportDeviceLost — function @experimental
```
(reason: number, message: string): void
diff --git a/sdk/package.json b/sdk/package.json
index e6614811a..32a555bfc 100644
--- a/sdk/package.json
+++ b/sdk/package.json
@@ -17,6 +17,7 @@
"./dist/tilemap/index.js",
"./dist/logic/index.js",
"./dist/ai/index.js",
+ "./dist/net/replication/index.js",
"./dist/physics/index.js",
"./dist/physics3d/index.js",
"./dist/douyin/index.js",
@@ -68,6 +69,10 @@
"import": "./dist/ai/index.js",
"types": "./dist/ai/index.d.ts"
},
+ "./replication": {
+ "import": "./dist/net/replication/index.js",
+ "types": "./dist/net/replication/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 970da7ce9..e4d479031 100644
--- a/sdk/rolldown.config.js
+++ b/sdk/rolldown.config.js
@@ -90,6 +90,7 @@ export default defineConfig([
'tilemap/index': 'src/tilemap/index.ts',
'logic/index': 'src/logic/index.ts',
'ai/index': 'src/ai/index.ts',
+ 'net/replication/index': 'src/net/replication/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 36ade234d..c3a9aba57 100644
--- a/sdk/rollup.config.js
+++ b/sdk/rollup.config.js
@@ -21,6 +21,7 @@ export default [
'tilemap/index': 'src/tilemap/index.ts',
'logic/index': 'src/logic/index.ts',
'ai/index': 'src/ai/index.ts',
+ 'net/replication/index': 'src/net/replication/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 36255532f..3cf1c93a8 100644
--- a/sdk/src/app/pluginSets.ts
+++ b/sdk/src/app/pluginSets.ts
@@ -34,7 +34,6 @@ import { timerPlugin } from '../ecs/timer';
import { velocityPlugin } from '../velocity';
import { lifecyclePlugin } from '../ecs/lifecycle';
import { eventBindingPlugin } from '../eventBinding';
-import { replicationPlugin } from '../net/replication';
import { servicesPlugin } from '../services';
import { diagnosticsPlugin } from '../diagnostics';
@@ -52,7 +51,7 @@ import { diagnosticsPlugin } from '../diagnostics';
export const simulationBasePlugins = (): Plugin[] => [
diagnosticsPlugin,
timerPlugin, velocityPlugin, lifecyclePlugin, audioPlugin,
- eventBindingPlugin, replicationPlugin,
+ eventBindingPlugin,
servicesPlugin,
];
@@ -97,6 +96,6 @@ export const webBasePlugins = (): Plugin[] => [
timerPlugin, velocityPlugin, lifecyclePlugin, animationPlugin, audioPlugin, videoPlugin,
particlePlugin, trailPlugin, meshRendererPlugin, postProcessPlugin, timelinePlugin,
gameplayPlugin,
- eventBindingPlugin, replicationPlugin,
+ eventBindingPlugin,
servicesPlugin,
];
diff --git a/sdk/src/core-sys.ts b/sdk/src/core-sys.ts
index f8f640f91..74b6a3587 100644
--- a/sdk/src/core-sys.ts
+++ b/sdk/src/core-sys.ts
@@ -89,29 +89,19 @@ export { ScreenInfo, ScreenOrientation, type ScreenInfoEvents } from './screen';
// Network
// =============================================================================
-export {
- GameSocket, MiniGameSocket, WeChatSocket, createSocket, NetChannel,
- MemoryTransport, createMemoryTransportPair,
- MessagePortTransport, type MessagePortLike,
- type GameSocketOptions, type SocketReadyState, type NetTransport,
- type ReliableOrderedTransport,
- type NetChannelOptions, type MessageHandler, type RequestHandler,
- type BinaryHandler, type PlatformSocket, type PlatformSocketEvents,
- type PlatformSocketOptions, type PlatformSocketReadyState,
-} from './net';
+// The sockets a platform adapter builds. The channel over one, and everything
+// replication does with it, is `esengine/replication`: it chunks with the
+// protocol, so a barrel that names it puts the protocol in every package.
+export { GameSocket, type GameSocketOptions, type SocketReadyState } from './net/GameSocket';
+export { MiniGameSocket } from './net/MiniGameSocket';
+export { WeChatSocket } from './net/WeChatSocket';
+export { createSocket } from './net/createSocket';
+export type { NetTransport, ReliableOrderedTransport } from './net/NetChannel';
+export type {
+ PlatformSocket, PlatformSocketEvents,
+ PlatformSocketOptions, PlatformSocketReadyState,
+} from './platform/types';
-export {
- replicationPlugin, ReplicationPlugin, Net, NetSession,
- Replicated, NetGhost, ReplicationServer, ReplicationClient,
- REPLICATION_PROTOCOL_VERSION, REPLICATION_CHANNEL,
- radiusInterest, radiusInterestProvider,
- registerReplicationArchetype,
- type NetRoleKind, type ReplicatedData,
- type InterestPolicy, type InterestView, type RadiusInterestOptions,
- type InterestProvider, type PreparedInterest, type InterestPoint,
- type InterestProviderPrepareView, type InterestProviderQueryView,
- type PredictionOptions, type PredictionSmoothing, type ReplicationArchetype,
-} from './net/replication';
// =============================================================================
// Platform (base functions only)
diff --git a/sdk/src/net/createSocket.ts b/sdk/src/net/createSocket.ts
new file mode 100644
index 000000000..839e75fb4
--- /dev/null
+++ b/sdk/src/net/createSocket.ts
@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file createSocket.ts — open a socket through the platform adapter.
+ *
+ * Its own module rather than the networking barrel's: the barrel re-exports
+ * replication, so anything that reaches it puts the protocol in the package.
+ */
+import { GameSocket, type GameSocketOptions } from './GameSocket';
+import { isPlatformInitialized, getPlatform } from '../platform/base';
+import type { PlatformSocket } from '../platform/types';
+
+/**
+ * Web → WebSocket, wechat → wx.connectSocket, node → ws. A platform without
+ * networking fails loud; a bare host with no adapter set (unit tests) falls
+ * back to the browser socket.
+ */
+export function createSocket(options: GameSocketOptions): PlatformSocket {
+ if (isPlatformInitialized()) {
+ const platform = getPlatform();
+ if (!platform.createSocket) {
+ throw new Error(`[net] platform "${platform.name}" has no socket support`);
+ }
+ return platform.createSocket(options);
+ }
+ return new GameSocket(options);
+}
diff --git a/sdk/src/net/index.ts b/sdk/src/net/index.ts
index 47256839f..ab1346538 100644
--- a/sdk/src/net/index.ts
+++ b/sdk/src/net/index.ts
@@ -25,23 +25,4 @@ export type {
PlatformSocketReadyState,
} from '../platform/types';
export * from './replication';
-
-import { GameSocket, type GameSocketOptions } from './GameSocket';
-import { isPlatformInitialized, getPlatform } from '../platform/base';
-import type { PlatformSocket } from '../platform/types';
-
-/**
- * Open a socket through the platform adapter (web → WebSocket, wechat →
- * wx.connectSocket, node → ws). A platform without networking fails loud; a
- * bare host with no adapter set (unit tests) falls back to the browser socket.
- */
-export function createSocket(options: GameSocketOptions): PlatformSocket {
- if (isPlatformInitialized()) {
- const platform = getPlatform();
- if (!platform.createSocket) {
- throw new Error(`[net] platform "${platform.name}" has no socket support`);
- }
- return platform.createSocket(options);
- }
- return new GameSocket(options);
-}
+export { createSocket } from './createSocket';
diff --git a/sdk/src/net/replication/index.ts b/sdk/src/net/replication/index.ts
index 214aff48a..491bfdf46 100644
--- a/sdk/src/net/replication/index.ts
+++ b/sdk/src/net/replication/index.ts
@@ -46,9 +46,7 @@ export {
type RadiusInterestOptions,
type InterestPoint,
} from './interest';
-export {
- registerReplicationArchetype, clearReplicationArchetypes, type ReplicationArchetype,
-} from './archetype';
+export { registerReplicationArchetype, type ReplicationArchetype } from './archetype';
export { NetIds } from './NetIds';
export { ReplicationServer } from './server';
export {
@@ -66,3 +64,17 @@ export {
Net,
type NetRoleKind,
} from './ReplicationPlugin';
+
+// Importing this subpath INSTALLS replication — see spine/index.ts.
+import { registerReplicationSupport } from './replicationSupport';
+
+registerReplicationSupport();
+
+// The channel and the transports a game drives replication over: they chunk
+// with the protocol, so this is where a package pays for them.
+export {
+ NetChannel,
+ type NetChannelOptions, type MessageHandler, type RequestHandler, type BinaryHandler,
+} from '../NetChannel';
+export { MemoryTransport, createMemoryTransportPair } from '../MemoryTransport';
+export { MessagePortTransport, type MessagePortLike } from '../MessagePortTransport';
diff --git a/sdk/src/net/replication/replicationSupport.ts b/sdk/src/net/replication/replicationSupport.ts
new file mode 100644
index 000000000..e5309ce0c
--- /dev/null
+++ b/sdk/src/net/replication/replicationSupport.ts
@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+/**
+ * @file replicationSupport.ts — what a build that ships replication tells the
+ * core. A call, not a file's side effect — see spine/spineSupport.ts.
+ *
+ * The sockets stay on `esengine`: a platform adapter builds one, and a game
+ * that only talks to a server over a channel needs no replication at all.
+ */
+import { addEntryPlugin } from '../../runtime/entryPlugins';
+import { ReplicationPlugin } from './ReplicationPlugin';
+
+export function registerReplicationSupport(): void {
+ addEntryPlugin('replication', () => new ReplicationPlugin());
+}
diff --git a/sdk/src/platform/nativeModuleRegistry.ts b/sdk/src/platform/nativeModuleRegistry.ts
index 47e14dcc4..161637724 100644
--- a/sdk/src/platform/nativeModuleRegistry.ts
+++ b/sdk/src/platform/nativeModuleRegistry.ts
@@ -26,6 +26,7 @@ import * as DragonBonesModule from '../dragonbones';
import * as TilemapModule from '../tilemap';
import * as ScriptGraphModule from '../logic';
import * as AiModule from '../ai';
+import * as ReplicationModule from '../net/replication';
/** Must equal NATIVE_MODULE_REGISTRY in tools/nativeScriptModules.mjs, which is
* what the exporter emits and what check-native-script-modules reads. */
@@ -43,6 +44,7 @@ export const NATIVE_MODULE_NAMESPACES: Readonly<Record<string, unknown>> = {
'esengine/tilemap': TilemapModule,
'esengine/logic': ScriptGraphModule,
'esengine/ai': AiModule,
+ 'esengine/replication': ReplicationModule,
};
/**
diff --git a/sdk/src/runtime/optionalPlugins.ts b/sdk/src/runtime/optionalPlugins.ts
index 724d4c2be..095c4efdb 100644
--- a/sdk/src/runtime/optionalPlugins.ts
+++ b/sdk/src/runtime/optionalPlugins.ts
@@ -22,6 +22,7 @@ import { registerPhysics3DSupport } from '../physics3d/physics3dSupport';
import { registerTilemapSupport } from '../tilemap/tilemapSupport';
import { registerScriptGraphSupport } from '../logic/logicSupport';
import { registerAiSupport } from '../ai/aiSupport';
+import { registerReplicationSupport } from '../net/replication/replicationSupport';
export function installOptionalPlugins(): void {
registerSpineSupport();
@@ -31,6 +32,7 @@ export function installOptionalPlugins(): void {
registerTilemapSupport();
registerScriptGraphSupport();
registerAiSupport();
+ registerReplicationSupport();
// Video has no subpath of its own to be installed from, so it registers here.
setSceneOptionals({
video: {
diff --git a/sdk/tests/replication-spawn-contract.test.ts b/sdk/tests/replication-spawn-contract.test.ts
index 392bafc12..40cbab370 100644
--- a/sdk/tests/replication-spawn-contract.test.ts
+++ b/sdk/tests/replication-spawn-contract.test.ts
@@ -26,9 +26,9 @@ import { App } from '../src/app/app';
import { clearUserComponents, defineComponent, Name, Transform, Sprite } from '../src/ecs/component';
import { MemoryTransport } from '../src/net/MemoryTransport';
import {
- replicationPlugin, Net, Replicated,
- registerReplicationArchetype, clearReplicationArchetypes, radiusInterest,
+ replicationPlugin, Net, Replicated, registerReplicationArchetype, radiusInterest,
} from '../src/net/replication';
+import { clearReplicationArchetypes } from '../src/net/replication/archetype';
import type { Entity } from '../src/types';
import type { CppRegistry, ESEngineModule } from '../src/wasm';
import { loadWasmModule, HAS_WASM } from './helpers/loadWasm';
diff --git a/tools/lib/sdkProgram.mjs b/tools/lib/sdkProgram.mjs
index 64e46ed3e..5d9b35bfa 100644
--- a/tools/lib/sdkProgram.mjs
+++ b/tools/lib/sdkProgram.mjs
@@ -61,6 +61,7 @@ export const ENTRIES = {
'tilemap': 'src/tilemap/index.ts',
'logic': 'src/logic/index.ts',
'ai': 'src/ai/index.ts',
+ 'replication': 'src/net/replication/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 88c2bdfa0..a2468eff5 100644
--- a/tools/nativeScriptModules.js
+++ b/tools/nativeScriptModules.js
@@ -67,6 +67,7 @@ export const MODULES = {
'esengine/tilemap': { disposition: 'native-subpath' },
'esengine/logic': { disposition: 'native-subpath' },
'esengine/ai': { disposition: 'native-subpath' },
+ 'esengine/replication': { disposition: 'native-subpath' },
'esengine/native': {
disposition: 'forbidden-native-script',