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.

chore(sdk): refresh API surface snapshots for the particle modules

yhh1362acf50fed
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index 2b2b1073a..8213f2895 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: 1261 stable · 17 beta · 0 deprecated
+Symbols: 1265 stable · 17 beta · 0 deprecated
## ABI_LAYOUT_HASH — const
```
-"4e0613ea05e766a3"
+"1ea8bcc5e5a72cc7"
```
## ANCHOR_AXES — const
@@ -1587,6 +1587,7 @@ addLight2D: (entity: Entity, component: Light2D) => void
addMesh2D: (entity: Entity, component: Mesh2D) => void
addParent: (entity: Entity, component: Parent) => void
addParticleEmitter: (entity: Entity, component: ParticleEmitter) => void
+addParticleForceField: (entity: Entity, component: ParticleForceField) => void
addRigidBody: (entity: Entity, component: RigidBody) => void
addSegmentCollider: (entity: Entity, component: SegmentCollider) => void
addShadowCaster2D: (entity: Entity, component: ShadowCaster2D) => void
@@ -1618,6 +1619,7 @@ getLight2D: (entity: Entity) => Light2D
getMesh2D: (entity: Entity) => Mesh2D
getParent: (entity: Entity) => Parent
getParticleEmitter: (entity: Entity) => ParticleEmitter
+getParticleForceField: (entity: Entity) => ParticleForceField
getRigidBody: (entity: Entity) => RigidBody
getSegmentCollider: (entity: Entity) => SegmentCollider
getShadowCaster2D: (entity: Entity) => ShadowCaster2D
@@ -1645,6 +1647,7 @@ hasLight2D: (entity: Entity) => boolean
hasMesh2D: (entity: Entity) => boolean
hasParent: (entity: Entity) => boolean
hasParticleEmitter: (entity: Entity) => boolean
+hasParticleForceField: (entity: Entity) => boolean
hasRigidBody: (entity: Entity) => boolean
hasSegmentCollider: (entity: Entity) => boolean
hasShadowCaster2D: (entity: Entity) => boolean
@@ -1672,6 +1675,7 @@ removeLight2D: (entity: Entity) => void
removeMesh2D: (entity: Entity) => void
removeParent: (entity: Entity) => void
removeParticleEmitter: (entity: Entity) => void
+removeParticleForceField: (entity: Entity) => void
removeRigidBody: (entity: Entity) => void
removeSegmentCollider: (entity: Entity) => void
removeShadowCaster2D: (entity: Entity) => void
@@ -2638,6 +2642,14 @@ target: number
number
```
+## ForceFieldType — enum
+```
+Directional = 0
+Drag = 3
+Point = 1
+Vortex = 2
+```
+
## FrameCaptureData — interface
```
cameraCount: number
@@ -4054,6 +4066,10 @@ lifetimeMin: number
looping: boolean
material: number
maxParticles: number
+noiseFrequency: number
+noiseOctaves: number
+noiseScrollSpeed: number
+noiseStrength: number
playOnStart: boolean
rate: number
rotationMax: number
@@ -4074,7 +4090,30 @@ spriteRows: number
startColor: Color
startSizeMax: number
startSizeMin: number
+subEmitter: number
+subEmitterChance: number
+subEmitterInheritVelocity: number
+subEmitterTrigger: number
texture: number
+trailEnabled: boolean
+trailMinDistance: number
+trailPoints: number
+trailWidth: number
+```
+
+## ParticleForceField — const
+```
+BuiltinComponentDef<ParticleForceFieldData>
+```
+
+## ParticleForceFieldData — interface
+```
+direction: Vec2
+enabled: boolean
+falloff: boolean
+radius: number
+strength: number
+type: number
```
## ParticlePlugin — class
@@ -5999,6 +6038,12 @@ toDeactivate: string[]
'unload' | 'sleep'
```
+## SubEmitterTrigger — enum
+```
+Birth = 1
+Death = 0
+```
+
## SubmitSkipFlags — const
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index 02e3c9170..173d327c2 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: 1260 stable · 19 beta · 0 deprecated
+Symbols: 1264 stable · 19 beta · 0 deprecated
## ANCHOR_AXES — const
```
@@ -1582,6 +1582,7 @@ addLight2D: (entity: Entity, component: Light2D) => void
addMesh2D: (entity: Entity, component: Mesh2D) => void
addParent: (entity: Entity, component: Parent) => void
addParticleEmitter: (entity: Entity, component: ParticleEmitter) => void
+addParticleForceField: (entity: Entity, component: ParticleForceField) => void
addRigidBody: (entity: Entity, component: RigidBody) => void
addSegmentCollider: (entity: Entity, component: SegmentCollider) => void
addShadowCaster2D: (entity: Entity, component: ShadowCaster2D) => void
@@ -1613,6 +1614,7 @@ getLight2D: (entity: Entity) => Light2D
getMesh2D: (entity: Entity) => Mesh2D
getParent: (entity: Entity) => Parent
getParticleEmitter: (entity: Entity) => ParticleEmitter
+getParticleForceField: (entity: Entity) => ParticleForceField
getRigidBody: (entity: Entity) => RigidBody
getSegmentCollider: (entity: Entity) => SegmentCollider
getShadowCaster2D: (entity: Entity) => ShadowCaster2D
@@ -1640,6 +1642,7 @@ hasLight2D: (entity: Entity) => boolean
hasMesh2D: (entity: Entity) => boolean
hasParent: (entity: Entity) => boolean
hasParticleEmitter: (entity: Entity) => boolean
+hasParticleForceField: (entity: Entity) => boolean
hasRigidBody: (entity: Entity) => boolean
hasSegmentCollider: (entity: Entity) => boolean
hasShadowCaster2D: (entity: Entity) => boolean
@@ -1667,6 +1670,7 @@ removeLight2D: (entity: Entity) => void
removeMesh2D: (entity: Entity) => void
removeParent: (entity: Entity) => void
removeParticleEmitter: (entity: Entity) => void
+removeParticleForceField: (entity: Entity) => void
removeRigidBody: (entity: Entity) => void
removeSegmentCollider: (entity: Entity) => void
removeShadowCaster2D: (entity: Entity) => void
@@ -2633,6 +2637,14 @@ target: number
number
```
+## ForceFieldType — enum
+```
+Directional = 0
+Drag = 3
+Point = 1
+Vortex = 2
+```
+
## FrameCaptureData — interface
```
cameraCount: number
@@ -4049,6 +4061,10 @@ lifetimeMin: number
looping: boolean
material: number
maxParticles: number
+noiseFrequency: number
+noiseOctaves: number
+noiseScrollSpeed: number
+noiseStrength: number
playOnStart: boolean
rate: number
rotationMax: number
@@ -4069,7 +4085,30 @@ spriteRows: number
startColor: Color
startSizeMax: number
startSizeMin: number
+subEmitter: number
+subEmitterChance: number
+subEmitterInheritVelocity: number
+subEmitterTrigger: number
texture: number
+trailEnabled: boolean
+trailMinDistance: number
+trailPoints: number
+trailWidth: number
+```
+
+## ParticleForceField — const
+```
+BuiltinComponentDef<ParticleForceFieldData>
+```
+
+## ParticleForceFieldData — interface
+```
+direction: Vec2
+enabled: boolean
+falloff: boolean
+radius: number
+strength: number
+type: number
```
## ParticlePlugin — class
@@ -5994,6 +6033,12 @@ toDeactivate: string[]
'unload' | 'sleep'
```
+## SubEmitterTrigger — enum
+```
+Birth = 1
+Death = 0
+```
+
## SubmitSkipFlags — const
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }
diff --git a/sdk/etc/wasm.api.md b/sdk/etc/wasm.api.md
index 859cc5143..c87806a9d 100644
--- a/sdk/etc/wasm.api.md
+++ b/sdk/etc/wasm.api.md
@@ -26,6 +26,7 @@ addLight2D: (entity: Entity, component: Light2D) => void
addMesh2D: (entity: Entity, component: Mesh2D) => void
addParent: (entity: Entity, component: Parent) => void
addParticleEmitter: (entity: Entity, component: ParticleEmitter) => void
+addParticleForceField: (entity: Entity, component: ParticleForceField) => void
addRigidBody: (entity: Entity, component: RigidBody) => void
addSegmentCollider: (entity: Entity, component: SegmentCollider) => void
addShadowCaster2D: (entity: Entity, component: ShadowCaster2D) => void
@@ -57,6 +58,7 @@ getLight2D: (entity: Entity) => Light2D
getMesh2D: (entity: Entity) => Mesh2D
getParent: (entity: Entity) => Parent
getParticleEmitter: (entity: Entity) => ParticleEmitter
+getParticleForceField: (entity: Entity) => ParticleForceField
getRigidBody: (entity: Entity) => RigidBody
getSegmentCollider: (entity: Entity) => SegmentCollider
getShadowCaster2D: (entity: Entity) => ShadowCaster2D
@@ -84,6 +86,7 @@ hasLight2D: (entity: Entity) => boolean
hasMesh2D: (entity: Entity) => boolean
hasParent: (entity: Entity) => boolean
hasParticleEmitter: (entity: Entity) => boolean
+hasParticleForceField: (entity: Entity) => boolean
hasRigidBody: (entity: Entity) => boolean
hasSegmentCollider: (entity: Entity) => boolean
hasShadowCaster2D: (entity: Entity) => boolean
@@ -111,6 +114,7 @@ removeLight2D: (entity: Entity) => void
removeMesh2D: (entity: Entity) => void
removeParent: (entity: Entity) => void
removeParticleEmitter: (entity: Entity) => void
+removeParticleForceField: (entity: Entity) => void
removeRigidBody: (entity: Entity) => void
removeSegmentCollider: (entity: Entity) => void
removeShadowCaster2D: (entity: Entity) => void
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index f3a46114e..0eff9c016 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: 1271 stable · 17 beta · 0 deprecated
+Symbols: 1275 stable · 17 beta · 0 deprecated
## ANCHOR_AXES — const
```
@@ -1582,6 +1582,7 @@ addLight2D: (entity: Entity, component: Light2D) => void
addMesh2D: (entity: Entity, component: Mesh2D) => void
addParent: (entity: Entity, component: Parent) => void
addParticleEmitter: (entity: Entity, component: ParticleEmitter) => void
+addParticleForceField: (entity: Entity, component: ParticleForceField) => void
addRigidBody: (entity: Entity, component: RigidBody) => void
addSegmentCollider: (entity: Entity, component: SegmentCollider) => void
addShadowCaster2D: (entity: Entity, component: ShadowCaster2D) => void
@@ -1613,6 +1614,7 @@ getLight2D: (entity: Entity) => Light2D
getMesh2D: (entity: Entity) => Mesh2D
getParent: (entity: Entity) => Parent
getParticleEmitter: (entity: Entity) => ParticleEmitter
+getParticleForceField: (entity: Entity) => ParticleForceField
getRigidBody: (entity: Entity) => RigidBody
getSegmentCollider: (entity: Entity) => SegmentCollider
getShadowCaster2D: (entity: Entity) => ShadowCaster2D
@@ -1640,6 +1642,7 @@ hasLight2D: (entity: Entity) => boolean
hasMesh2D: (entity: Entity) => boolean
hasParent: (entity: Entity) => boolean
hasParticleEmitter: (entity: Entity) => boolean
+hasParticleForceField: (entity: Entity) => boolean
hasRigidBody: (entity: Entity) => boolean
hasSegmentCollider: (entity: Entity) => boolean
hasShadowCaster2D: (entity: Entity) => boolean
@@ -1667,6 +1670,7 @@ removeLight2D: (entity: Entity) => void
removeMesh2D: (entity: Entity) => void
removeParent: (entity: Entity) => void
removeParticleEmitter: (entity: Entity) => void
+removeParticleForceField: (entity: Entity) => void
removeRigidBody: (entity: Entity) => void
removeSegmentCollider: (entity: Entity) => void
removeShadowCaster2D: (entity: Entity) => void
@@ -2633,6 +2637,14 @@ target: number
number
```
+## ForceFieldType — enum
+```
+Directional = 0
+Drag = 3
+Point = 1
+Vortex = 2
+```
+
## FrameCaptureData — interface
```
cameraCount: number
@@ -4056,6 +4068,10 @@ lifetimeMin: number
looping: boolean
material: number
maxParticles: number
+noiseFrequency: number
+noiseOctaves: number
+noiseScrollSpeed: number
+noiseStrength: number
playOnStart: boolean
rate: number
rotationMax: number
@@ -4076,7 +4092,30 @@ spriteRows: number
startColor: Color
startSizeMax: number
startSizeMin: number
+subEmitter: number
+subEmitterChance: number
+subEmitterInheritVelocity: number
+subEmitterTrigger: number
texture: number
+trailEnabled: boolean
+trailMinDistance: number
+trailPoints: number
+trailWidth: number
+```
+
+## ParticleForceField — const
+```
+BuiltinComponentDef<ParticleForceFieldData>
+```
+
+## ParticleForceFieldData — interface
+```
+direction: Vec2
+enabled: boolean
+falloff: boolean
+radius: number
+strength: number
+type: number
```
## ParticlePlugin — class
@@ -6001,6 +6040,12 @@ toDeactivate: string[]
'unload' | 'sleep'
```
+## SubEmitterTrigger — enum
+```
+Birth = 1
+Death = 0
+```
+
## SubmitSkipFlags — const
```
{ readonly None: 0; readonly Spine: 1; readonly Particles: 2; }