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.

fix(ci): refresh API-surface snapshots + pin their line ending

yhhce638f16422b
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 000000000..d88fb28e2
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,4 @@
+# Generated API-surface snapshots are written with LF by tools/api-surface.mjs.
+# Pin the line ending so a CRLF checkout on Windows can't masquerade as API drift
+# and fail the CI api-surface guard on a Linux runner.
+sdk/etc/*.api.md text eol=lf
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 334ccea8d..6e35d7e44 100644
--- a/sdk/etc/index.api.md
+++ b/sdk/etc/index.api.md
@@ -1,11 +1,11 @@
# API surface — esengine/index
<!-- Generated by tools/api-surface.mjs — do not edit. Run --update to accept changes. -->
-Symbols: 1043 stable · 44 beta · 1 deprecated
+Symbols: 1051 stable · 44 beta · 1 deprecated
## ABI_LAYOUT_HASH — const
```
-"89e3ae10e24e8bc9"
+"89ad72a9b853289f"
```
## ActionDef — interface
@@ -363,6 +363,11 @@ static new (): AppContext
static prototype: AppContext
```
+## ApplyTilesetRefs — type
+```
+(entity: number, refs: readonly string[]) => void
+```
+
## ArrayDataSource — class
```
append: (items: readonly T[]) => void
@@ -1370,6 +1375,7 @@ addSprite: (entity: Entity, component: Sprite) => void
addStateMachine: (entity: Entity, component: StateMachine) => void
addStateVisuals: (entity: Entity, component: StateVisuals) => void
addTilemapLayer: (entity: Entity, component: TilemapLayer) => void
+addTrailRenderer: (entity: Entity, component: TrailRenderer) => void
addTransform: (entity: Entity, component: Transform) => void
addUIInteraction: (entity: Entity, component: UIInteraction) => void
addUIMask: (entity: Entity, component: UIMask) => void
@@ -1402,6 +1408,7 @@ getSprite: (entity: Entity) => Sprite
getStateMachine: (entity: Entity) => StateMachine
getStateVisuals: (entity: Entity) => StateVisuals
getTilemapLayer: (entity: Entity) => TilemapLayer
+getTrailRenderer: (entity: Entity) => TrailRenderer
getTransform: (entity: Entity) => Transform
getUIInteraction: (entity: Entity) => UIInteraction
getUIMask: (entity: Entity) => UIMask
@@ -1430,6 +1437,7 @@ hasSprite: (entity: Entity) => boolean
hasStateMachine: (entity: Entity) => boolean
hasStateVisuals: (entity: Entity) => boolean
hasTilemapLayer: (entity: Entity) => boolean
+hasTrailRenderer: (entity: Entity) => boolean
hasTransform: (entity: Entity) => boolean
hasUIInteraction: (entity: Entity) => boolean
hasUIMask: (entity: Entity) => boolean
@@ -1458,6 +1466,7 @@ removeSprite: (entity: Entity) => void
removeStateMachine: (entity: Entity) => void
removeStateVisuals: (entity: Entity) => void
removeTilemapLayer: (entity: Entity) => void
+removeTrailRenderer: (entity: Entity) => void
removeTransform: (entity: Entity) => void
removeUIInteraction: (entity: Entity) => void
removeUIMask: (entity: Entity) => void
@@ -2026,6 +2035,8 @@ tilemap_initInfinite: ((entity: number, tileWidth: number, tileHeight: number) =
tilemap_initLayer: ((entity: number, width: number, height: number, tileWidth: number, tileHeight: number) => void) | undefined
tilemap_setTile: ((entity: number, x: number, y: number, tileId: number) => void) | undefined
tilemap_setTiles: ((entity: number, tilesPtr: number, count: number) => void) | undefined
+trail_clear: ((registry: CppRegistry, entity: number) => void) | undefined
+trail_update: ((registry: CppRegistry, dt: number) => void) | undefined
transform_patchPosition: (registry: CppRegistry, entity: number, x: number, y: number, z: number) => void
transform_update: (registry: CppRegistry) => void
uiFlexLayout_update: (registry: CppRegistry) => void
@@ -3108,6 +3119,7 @@ tilesets: LoadedTilemapTileset[]
```
columns: number
firstId: number
+rows: number
textureHandle: number
```
@@ -3359,11 +3371,8 @@ message: string
missing: MissingAsset[]
name: string
stack: string | undefined
-static captureStackTrace: (targetObject: object, constructorOpt?: Function) => void
static new (missing: import("./asset/Assets").MissingAsset[]): MissingAssetsError
-static prepareStackTrace: (err: Error, stackTraces: NodeJS.CallSite[]) => any
static prototype: MissingAssetsError
-static stackTraceLimit: number
```
## Modifiers — interface
@@ -5913,6 +5922,11 @@ tintColor: Color
visible: boolean
```
+## TilemapLiveSync — const
+```
+{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
+```
+
## TilemapPlugin — class
```
build: (app: App) => void
@@ -6124,6 +6138,48 @@ PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | Ma
(typeof TrackType)[keyof typeof TrackType]
```
+## Trail — const
+```
+ResourceDef<TrailAPI>
+```
+
+## TrailAPI — class
+```
+clear: (entity: Entity) => void
+update: (dt: number) => void
+static new (module: ESEngineModule, registry: CppRegistry): TrailAPI
+static prototype: TrailAPI
+```
+
+## TrailPlugin — class
+```
+build: (app: App) => void
+name: string
+static new (): TrailPlugin
+static prototype: TrailPlugin
+```
+
+## TrailRenderer — const
+```
+BuiltinComponentDef<TrailRendererData>
+```
+
+## TrailRendererData — interface
+```
+blendMode: number
+emitting: boolean
+enabled: boolean
+endColor: Color
+endWidth: number
+layer: number
+material: number
+minVertexDistance: number
+startColor: Color
+startWidth: number
+texture: number
+time: number
+```
+
## Transaction — class
```
add: (op: TransactionOp) => void
@@ -8369,6 +8425,11 @@ Plugin
(path: string): string
```
+## trailPlugin — const
+```
+TrailPlugin
+```
+
## transitionTo — function
```
(app: App, targetScene: string, config: TransitionConfig): Promise<void>
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index 8c39a4800..bda110503 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: 1042 stable · 46 beta · 1 deprecated
+Symbols: 1050 stable · 46 beta · 1 deprecated
## ActionDef — interface
```
@@ -358,6 +358,11 @@ static new (): AppContext
static prototype: AppContext
```
+## ApplyTilesetRefs — type
+```
+(entity: number, refs: readonly string[]) => void
+```
+
## ArrayDataSource — class
```
append: (items: readonly T[]) => void
@@ -1365,6 +1370,7 @@ addSprite: (entity: Entity, component: Sprite) => void
addStateMachine: (entity: Entity, component: StateMachine) => void
addStateVisuals: (entity: Entity, component: StateVisuals) => void
addTilemapLayer: (entity: Entity, component: TilemapLayer) => void
+addTrailRenderer: (entity: Entity, component: TrailRenderer) => void
addTransform: (entity: Entity, component: Transform) => void
addUIInteraction: (entity: Entity, component: UIInteraction) => void
addUIMask: (entity: Entity, component: UIMask) => void
@@ -1397,6 +1403,7 @@ getSprite: (entity: Entity) => Sprite
getStateMachine: (entity: Entity) => StateMachine
getStateVisuals: (entity: Entity) => StateVisuals
getTilemapLayer: (entity: Entity) => TilemapLayer
+getTrailRenderer: (entity: Entity) => TrailRenderer
getTransform: (entity: Entity) => Transform
getUIInteraction: (entity: Entity) => UIInteraction
getUIMask: (entity: Entity) => UIMask
@@ -1425,6 +1432,7 @@ hasSprite: (entity: Entity) => boolean
hasStateMachine: (entity: Entity) => boolean
hasStateVisuals: (entity: Entity) => boolean
hasTilemapLayer: (entity: Entity) => boolean
+hasTrailRenderer: (entity: Entity) => boolean
hasTransform: (entity: Entity) => boolean
hasUIInteraction: (entity: Entity) => boolean
hasUIMask: (entity: Entity) => boolean
@@ -1453,6 +1461,7 @@ removeSprite: (entity: Entity) => void
removeStateMachine: (entity: Entity) => void
removeStateVisuals: (entity: Entity) => void
removeTilemapLayer: (entity: Entity) => void
+removeTrailRenderer: (entity: Entity) => void
removeTransform: (entity: Entity) => void
removeUIInteraction: (entity: Entity) => void
removeUIMask: (entity: Entity) => void
@@ -2021,6 +2030,8 @@ tilemap_initInfinite: ((entity: number, tileWidth: number, tileHeight: number) =
tilemap_initLayer: ((entity: number, width: number, height: number, tileWidth: number, tileHeight: number) => void) | undefined
tilemap_setTile: ((entity: number, x: number, y: number, tileId: number) => void) | undefined
tilemap_setTiles: ((entity: number, tilesPtr: number, count: number) => void) | undefined
+trail_clear: ((registry: CppRegistry, entity: number) => void) | undefined
+trail_update: ((registry: CppRegistry, dt: number) => void) | undefined
transform_patchPosition: (registry: CppRegistry, entity: number, x: number, y: number, z: number) => void
transform_update: (registry: CppRegistry) => void
uiFlexLayout_update: (registry: CppRegistry) => void
@@ -3103,6 +3114,7 @@ tilesets: LoadedTilemapTileset[]
```
columns: number
firstId: number
+rows: number
textureHandle: number
```
@@ -3354,11 +3366,8 @@ message: string
missing: MissingAsset[]
name: string
stack: string | undefined
-static captureStackTrace: (targetObject: object, constructorOpt?: Function) => void
static new (missing: import("./asset/Assets").MissingAsset[]): MissingAssetsError
-static prepareStackTrace: (err: Error, stackTraces: NodeJS.CallSite[]) => any
static prototype: MissingAssetsError
-static stackTraceLimit: number
```
## Modifiers — interface
@@ -5908,6 +5917,11 @@ tintColor: Color
visible: boolean
```
+## TilemapLiveSync — const
+```
+{ _bind(fn: ApplyTilesetRefs | null): void; setLayerTilesets(entity: number, refs: readonly string[]): void; }
+```
+
## TilemapPlugin — class
```
build: (app: App) => void
@@ -6119,6 +6133,48 @@ PropertyTrack | SpineTrack | SpriteAnimTrack | AudioTrack | ActivationTrack | Ma
(typeof TrackType)[keyof typeof TrackType]
```
+## Trail — const
+```
+ResourceDef<TrailAPI>
+```
+
+## TrailAPI — class
+```
+clear: (entity: Entity) => void
+update: (dt: number) => void
+static new (module: ESEngineModule, registry: CppRegistry): TrailAPI
+static prototype: TrailAPI
+```
+
+## TrailPlugin — class
+```
+build: (app: App) => void
+name: string
+static new (): TrailPlugin
+static prototype: TrailPlugin
+```
+
+## TrailRenderer — const
+```
+BuiltinComponentDef<TrailRendererData>
+```
+
+## TrailRendererData — interface
+```
+blendMode: number
+emitting: boolean
+enabled: boolean
+endColor: Color
+endWidth: number
+layer: number
+material: number
+minVertexDistance: number
+startColor: Color
+startWidth: number
+texture: number
+time: number
+```
+
## Transaction — class
```
add: (op: TransactionOp) => void
@@ -8374,6 +8430,11 @@ Plugin
(path: string): string
```
+## trailPlugin — const
+```
+TrailPlugin
+```
+
## transitionTo — function
```
(app: App, targetScene: string, config: TransitionConfig): Promise<void>
diff --git a/sdk/etc/wasm.api.md b/sdk/etc/wasm.api.md
index ae1e30bcf..74019ff82 100644
--- a/sdk/etc/wasm.api.md
+++ b/sdk/etc/wasm.api.md
@@ -35,6 +35,7 @@ addSprite: (entity: Entity, component: Sprite) => void
addStateMachine: (entity: Entity, component: StateMachine) => void
addStateVisuals: (entity: Entity, component: StateVisuals) => void
addTilemapLayer: (entity: Entity, component: TilemapLayer) => void
+addTrailRenderer: (entity: Entity, component: TrailRenderer) => void
addTransform: (entity: Entity, component: Transform) => void
addUIInteraction: (entity: Entity, component: UIInteraction) => void
addUIMask: (entity: Entity, component: UIMask) => void
@@ -67,6 +68,7 @@ getSprite: (entity: Entity) => Sprite
getStateMachine: (entity: Entity) => StateMachine
getStateVisuals: (entity: Entity) => StateVisuals
getTilemapLayer: (entity: Entity) => TilemapLayer
+getTrailRenderer: (entity: Entity) => TrailRenderer
getTransform: (entity: Entity) => Transform
getUIInteraction: (entity: Entity) => UIInteraction
getUIMask: (entity: Entity) => UIMask
@@ -95,6 +97,7 @@ hasSprite: (entity: Entity) => boolean
hasStateMachine: (entity: Entity) => boolean
hasStateVisuals: (entity: Entity) => boolean
hasTilemapLayer: (entity: Entity) => boolean
+hasTrailRenderer: (entity: Entity) => boolean
hasTransform: (entity: Entity) => boolean
hasUIInteraction: (entity: Entity) => boolean
hasUIMask: (entity: Entity) => boolean
@@ -123,6 +126,7 @@ removeSprite: (entity: Entity) => void
removeStateMachine: (entity: Entity) => void
removeStateVisuals: (entity: Entity) => void
removeTilemapLayer: (entity: Entity) => void
+removeTrailRenderer: (entity: Entity) => void
removeTransform: (entity: Entity) => void
removeUIInteraction: (entity: Entity) => void
removeUIMask: (entity: Entity) => void
@@ -347,6 +351,8 @@ tilemap_initInfinite: ((entity: number, tileWidth: number, tileHeight: number) =
tilemap_initLayer: ((entity: number, width: number, height: number, tileWidth: number, tileHeight: number) => void) | undefined
tilemap_setTile: ((entity: number, x: number, y: number, tileId: number) => void) | undefined
tilemap_setTiles: ((entity: number, tilesPtr: number, count: number) => void) | undefined
+trail_clear: ((registry: CppRegistry, entity: number) => void) | undefined
+trail_update: ((registry: CppRegistry, dt: number) => void) | undefined
transform_patchPosition: (registry: CppRegistry, entity: number, x: number, y: number, z: number) => void
transform_update: (registry: CppRegistry) => void
uiFlexLayout_update: (registry: CppRegistry) => void