Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

feat(eht): a component field that is an enum is generated as one

esengine96cd4157f309
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e9594a40d..3a9399629 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -116,6 +116,19 @@ published separately; it ships inside the editor.
nothing. The order is the library's now; what to say when the engine is not
built stays with each caller, which is the half that is actually theirs.
+- **A component field that IS an enum is typed as one — 33 of them were `number`.**
+ The generator had the answer and threw it away: `if is_enum(t): return 'number'`,
+ with `ES_PROPERTY(enum=)` naming the enum for the fields stored as a `u8`. So
+ `Camera.projectionType`, `Light.type`, `ParticleEmitter.shape`,
+ `TilemapLayer.orientation`, the five `FlexContainer` fields and 24 more could
+ hold any number at all, and the enum spelling next to them was decoration.
+
+ They carry their enum now, imported from the generated module like the struct
+ types already were. **Tightening found nothing wrong** — the SDK, the editor,
+ the plugins and the examples all compile unchanged, which says the values were
+ right and the types could not say so. The behaviour is pinned by a test that
+ walks the C++ annotations, so putting `number` back turns it red.
+
- **`check-enum-twins` — nine TS enums that restate a C++ one are held to it, and
a machine says which ones nobody was holding.** These cross the boundary as
bare numbers, so a drift raises nothing: the SDK writes 1 where the renderer
diff --git a/sdk/etc/index.api.md b/sdk/etc/index.api.md
index cfff40c6f..8db772f58 100644
--- a/sdk/etc/index.api.md
+++ b/sdk/etc/index.api.md
@@ -1222,7 +1222,7 @@ BuiltinComponentDef<BitmapTextData>
## BitmapTextData — interface @experimental
```
-align: number
+align: TextAlign
color: Color
enabled: boolean
font: number
@@ -1559,7 +1559,7 @@ minY: number
## CameraData — interface @beta
```
aspectRatio: number
-clearFlags: number
+clearFlags: ClearFlags
cullingMask: number
farPlane: number
fov: number
@@ -1568,7 +1568,7 @@ nearPlane: number
orthoSize: number
pixelPerfect: boolean
priority: number
-projectionType: number
+projectionType: ProjectionType
renderTarget: number
showFrustum: boolean
viewport: Vec4
@@ -1693,7 +1693,7 @@ designResolution: Vec2
layer: number
matchWidthOrHeight: number
pixelsPerUnit: number
-scaleMode: number
+scaleMode: CanvasScaleMode
```
## CanvasScale — interface @experimental
@@ -4111,7 +4111,7 @@ shadowDistance: number
shadowExtent: number
shadowSoftness: number
sourceAngle: number
-type: number
+type: LightType
```
## LightType — enum @experimental
@@ -5200,7 +5200,7 @@ collisionEnabled: boolean
collisionFloor: number
collisionFriction: number
collisionLifetimeLoss: number
-colorEasing: number
+colorEasing: ParticleEasing
colorGradient: { stops: { t: number; color: Color; }[]; }
damping: number
duration: number
@@ -5223,13 +5223,13 @@ playOnStart: boolean
rate: number
rotationMax: number
rotationMin: number
-shape: number
+shape: EmitterShape
shapeAngle: number
shapeRadius: number
shapeSize: Vec3
-simulationSpace: number
+simulationSpace: SimulationSpace
sizeCurve: { keys: { t: number; v: number; }[]; }
-sizeEasing: number
+sizeEasing: ParticleEasing
speedMax: number
speedMin: number
spriteColumns: number
@@ -5242,7 +5242,7 @@ startSizeMin: number
subEmitter: number
subEmitterChance: number
subEmitterInheritVelocity: number
-subEmitterTrigger: number
+subEmitterTrigger: SubEmitterTrigger
texture: number
trailEnabled: boolean
trailMinDistance: number
@@ -5262,7 +5262,7 @@ enabled: boolean
falloff: boolean
radius: number
strength: number
-type: number
+type: ForceFieldType
```
## ParticlePlugin — class @experimental
@@ -6581,7 +6581,7 @@ BuiltinComponentDef<RigidBody3DData>
## RigidBody3DData — interface @experimental
```
angularDamping: number
-bodyType: number
+bodyType: BodyType
continuousCollision: boolean
enabled: boolean
fixedRotation: boolean
@@ -7165,7 +7165,7 @@ cornerRadius: number
enabled: boolean
layer: number
parallax: Vec2
-shapeType: number
+shapeType: ShapeType
size: Vec2
```
@@ -8252,12 +8252,12 @@ BuiltinComponentDef<TilemapLayerData>
cellSize: Vec2
hexSideLength: number
opacity: number
-orientation: number
+orientation: TilemapOrientation
originOffset: Vec2
parallaxFactor: Vec2
renderLayer: number
-staggerAxis: number
-staggerIndex: number
+staggerAxis: TilemapStaggerAxis
+staggerIndex: TilemapStaggerIndex
tileset: number
tilesetColumns: number
tintColor: Color
diff --git a/sdk/etc/index.native.api.md b/sdk/etc/index.native.api.md
index 6f3aea43a..897f37c4c 100644
--- a/sdk/etc/index.native.api.md
+++ b/sdk/etc/index.native.api.md
@@ -1222,7 +1222,7 @@ BuiltinComponentDef<BitmapTextData>
## BitmapTextData — interface @experimental
```
-align: number
+align: TextAlign
color: Color
enabled: boolean
font: number
@@ -1559,7 +1559,7 @@ minY: number
## CameraData — interface @beta
```
aspectRatio: number
-clearFlags: number
+clearFlags: ClearFlags
cullingMask: number
farPlane: number
fov: number
@@ -1568,7 +1568,7 @@ nearPlane: number
orthoSize: number
pixelPerfect: boolean
priority: number
-projectionType: number
+projectionType: ProjectionType
renderTarget: number
showFrustum: boolean
viewport: Vec4
@@ -1693,7 +1693,7 @@ designResolution: Vec2
layer: number
matchWidthOrHeight: number
pixelsPerUnit: number
-scaleMode: number
+scaleMode: CanvasScaleMode
```
## CanvasScale — interface @experimental
@@ -4119,7 +4119,7 @@ shadowDistance: number
shadowExtent: number
shadowSoftness: number
sourceAngle: number
-type: number
+type: LightType
```
## LightType — enum @experimental
@@ -5383,7 +5383,7 @@ collisionEnabled: boolean
collisionFloor: number
collisionFriction: number
collisionLifetimeLoss: number
-colorEasing: number
+colorEasing: ParticleEasing
colorGradient: { stops: { t: number; color: Color; }[]; }
damping: number
duration: number
@@ -5406,13 +5406,13 @@ playOnStart: boolean
rate: number
rotationMax: number
rotationMin: number
-shape: number
+shape: EmitterShape
shapeAngle: number
shapeRadius: number
shapeSize: Vec3
-simulationSpace: number
+simulationSpace: SimulationSpace
sizeCurve: { keys: { t: number; v: number; }[]; }
-sizeEasing: number
+sizeEasing: ParticleEasing
speedMax: number
speedMin: number
spriteColumns: number
@@ -5425,7 +5425,7 @@ startSizeMin: number
subEmitter: number
subEmitterChance: number
subEmitterInheritVelocity: number
-subEmitterTrigger: number
+subEmitterTrigger: SubEmitterTrigger
texture: number
trailEnabled: boolean
trailMinDistance: number
@@ -5445,7 +5445,7 @@ enabled: boolean
falloff: boolean
radius: number
strength: number
-type: number
+type: ForceFieldType
```
## ParticlePlugin — class @experimental
@@ -6774,7 +6774,7 @@ BuiltinComponentDef<RigidBody3DData>
## RigidBody3DData — interface @experimental
```
angularDamping: number
-bodyType: number
+bodyType: BodyType
continuousCollision: boolean
enabled: boolean
fixedRotation: boolean
@@ -7358,7 +7358,7 @@ cornerRadius: number
enabled: boolean
layer: number
parallax: Vec2
-shapeType: number
+shapeType: ShapeType
size: Vec2
```
@@ -8445,12 +8445,12 @@ BuiltinComponentDef<TilemapLayerData>
cellSize: Vec2
hexSideLength: number
opacity: number
-orientation: number
+orientation: TilemapOrientation
originOffset: Vec2
parallaxFactor: Vec2
renderLayer: number
-staggerAxis: number
-staggerIndex: number
+staggerAxis: TilemapStaggerAxis
+staggerIndex: TilemapStaggerIndex
tileset: number
tilesetColumns: number
tintColor: Color
diff --git a/sdk/etc/index.node.api.md b/sdk/etc/index.node.api.md
index 91d2ce474..f022127ae 100644
--- a/sdk/etc/index.node.api.md
+++ b/sdk/etc/index.node.api.md
@@ -1217,7 +1217,7 @@ BuiltinComponentDef<BitmapTextData>
## BitmapTextData — interface @experimental
```
-align: number
+align: TextAlign
color: Color
enabled: boolean
font: number
@@ -1554,7 +1554,7 @@ minY: number
## CameraData — interface @beta
```
aspectRatio: number
-clearFlags: number
+clearFlags: ClearFlags
cullingMask: number
farPlane: number
fov: number
@@ -1563,7 +1563,7 @@ nearPlane: number
orthoSize: number
pixelPerfect: boolean
priority: number
-projectionType: number
+projectionType: ProjectionType
renderTarget: number
showFrustum: boolean
viewport: Vec4
@@ -1688,7 +1688,7 @@ designResolution: Vec2
layer: number
matchWidthOrHeight: number
pixelsPerUnit: number
-scaleMode: number
+scaleMode: CanvasScaleMode
```
## CanvasScale — interface @experimental
@@ -4106,7 +4106,7 @@ shadowDistance: number
shadowExtent: number
shadowSoftness: number
sourceAngle: number
-type: number
+type: LightType
```
## LightType — enum @experimental
@@ -5195,7 +5195,7 @@ collisionEnabled: boolean
collisionFloor: number
collisionFriction: number
collisionLifetimeLoss: number
-colorEasing: number
+colorEasing: ParticleEasing
colorGradient: { stops: { t: number; color: Color; }[]; }
damping: number
duration: number
@@ -5218,13 +5218,13 @@ playOnStart: boolean
rate: number
rotationMax: number
rotationMin: number
-shape: number
+shape: EmitterShape
shapeAngle: number
shapeRadius: number
shapeSize: Vec3
-simulationSpace: number
+simulationSpace: SimulationSpace
sizeCurve: { keys: { t: number; v: number; }[]; }
-sizeEasing: number
+sizeEasing: ParticleEasing
speedMax: number
speedMin: number
spriteColumns: number
@@ -5237,7 +5237,7 @@ startSizeMin: number
subEmitter: number
subEmitterChance: number
subEmitterInheritVelocity: number
-subEmitterTrigger: number
+subEmitterTrigger: SubEmitterTrigger
texture: number
trailEnabled: boolean
trailMinDistance: number
@@ -5257,7 +5257,7 @@ enabled: boolean
falloff: boolean
radius: number
strength: number
-type: number
+type: ForceFieldType
```
## ParticlePlugin — class @experimental
@@ -6576,7 +6576,7 @@ BuiltinComponentDef<RigidBody3DData>
## RigidBody3DData — interface @experimental
```
angularDamping: number
-bodyType: number
+bodyType: BodyType
continuousCollision: boolean
enabled: boolean
fixedRotation: boolean
@@ -7160,7 +7160,7 @@ cornerRadius: number
enabled: boolean
layer: number
parallax: Vec2
-shapeType: number
+shapeType: ShapeType
size: Vec2
```
@@ -8247,12 +8247,12 @@ BuiltinComponentDef<TilemapLayerData>
cellSize: Vec2
hexSideLength: number
opacity: number
-orientation: number
+orientation: TilemapOrientation
originOffset: Vec2
parallaxFactor: Vec2
renderLayer: number
-staggerAxis: number
-staggerIndex: number
+staggerAxis: TilemapStaggerAxis
+staggerIndex: TilemapStaggerIndex
tileset: number
tilesetColumns: number
tintColor: Color
diff --git a/sdk/etc/minigame.api.md b/sdk/etc/minigame.api.md
index dbf9a0ecd..881fed552 100644
--- a/sdk/etc/minigame.api.md
+++ b/sdk/etc/minigame.api.md
@@ -1217,7 +1217,7 @@ BuiltinComponentDef<BitmapTextData>
## BitmapTextData — interface @experimental
```
-align: number
+align: TextAlign
color: Color
enabled: boolean
font: number
@@ -1554,7 +1554,7 @@ minY: number
## CameraData — interface @beta
```
aspectRatio: number
-clearFlags: number
+clearFlags: ClearFlags
cullingMask: number
farPlane: number
fov: number
@@ -1563,7 +1563,7 @@ nearPlane: number
orthoSize: number
pixelPerfect: boolean
priority: number
-projectionType: number
+projectionType: ProjectionType
renderTarget: number
showFrustum: boolean
viewport: Vec4
@@ -1688,7 +1688,7 @@ designResolution: Vec2
layer: number
matchWidthOrHeight: number
pixelsPerUnit: number
-scaleMode: number
+scaleMode: CanvasScaleMode
```
## CanvasScale — interface @experimental
@@ -4106,7 +4106,7 @@ shadowDistance: number
shadowExtent: number
shadowSoftness: number
sourceAngle: number
-type: number
+type: LightType
```
## LightType — enum @experimental
@@ -5441,7 +5441,7 @@ collisionEnabled: boolean
collisionFloor: number
collisionFriction: number
collisionLifetimeLoss: number
-colorEasing: number
+colorEasing: ParticleEasing
colorGradient: { stops: { t: number; color: Color; }[]; }
damping: number
duration: number
@@ -5464,13 +5464,13 @@ playOnStart: boolean
rate: number
rotationMax: number
rotationMin: number
-shape: number
+shape: EmitterShape
shapeAngle: number
shapeRadius: number
shapeSize: Vec3
-simulationSpace: number
+simulationSpace: SimulationSpace
sizeCurve: { keys: { t: number; v: number; }[]; }
-sizeEasing: number
+sizeEasing: ParticleEasing
speedMax: number
speedMin: number
spriteColumns: number
@@ -5483,7 +5483,7 @@ startSizeMin: number
subEmitter: number
subEmitterChance: number
subEmitterInheritVelocity: number
-subEmitterTrigger: number
+subEmitterTrigger: SubEmitterTrigger
texture: number
trailEnabled: boolean
trailMinDistance: number
@@ -5503,7 +5503,7 @@ enabled: boolean
falloff: boolean
radius: number
strength: number
-type: number
+type: ForceFieldType
```
## ParticlePlugin — class @experimental
@@ -6822,7 +6822,7 @@ BuiltinComponentDef<RigidBody3DData>
## RigidBody3DData — interface @experimental
```
angularDamping: number
-bodyType: number
+bodyType: BodyType
continuousCollision: boolean
enabled: boolean
fixedRotation: boolean
@@ -7406,7 +7406,7 @@ cornerRadius: number
enabled: boolean
layer: number
parallax: Vec2
-shapeType: number
+shapeType: ShapeType
size: Vec2
```
@@ -8493,12 +8493,12 @@ BuiltinComponentDef<TilemapLayerData>
cellSize: Vec2
hexSideLength: number
opacity: number
-orientation: number
+orientation: TilemapOrientation
originOffset: Vec2
parallaxFactor: Vec2
renderLayer: number
-staggerAxis: number
-staggerIndex: number
+staggerAxis: TilemapStaggerAxis
+staggerIndex: TilemapStaggerIndex
tileset: number
tilesetColumns: number
tintColor: Color
diff --git a/sdk/etc/physics3d.api.md b/sdk/etc/physics3d.api.md
index a5fd13aa2..a8547045b 100644
--- a/sdk/etc/physics3d.api.md
+++ b/sdk/etc/physics3d.api.md
@@ -356,7 +356,7 @@ BuiltinComponentDef<RigidBody3DData>
## RigidBody3DData — interface @experimental
```
angularDamping: number
-bodyType: number
+bodyType: BodyType
continuousCollision: boolean
enabled: boolean
fixedRotation: boolean
diff --git a/sdk/etc/wechat.api.md b/sdk/etc/wechat.api.md
index d2ed49776..f5babfcfb 100644
--- a/sdk/etc/wechat.api.md
+++ b/sdk/etc/wechat.api.md
@@ -1217,7 +1217,7 @@ BuiltinComponentDef<BitmapTextData>
## BitmapTextData — interface @experimental
```
-align: number
+align: TextAlign
color: Color
enabled: boolean
font: number
@@ -1554,7 +1554,7 @@ minY: number
## CameraData — interface @beta
```
aspectRatio: number
-clearFlags: number
+clearFlags: ClearFlags
cullingMask: number
farPlane: number
fov: number
@@ -1563,7 +1563,7 @@ nearPlane: number
orthoSize: number
pixelPerfect: boolean
priority: number
-projectionType: number
+projectionType: ProjectionType
renderTarget: number
showFrustum: boolean
viewport: Vec4
@@ -1688,7 +1688,7 @@ designResolution: Vec2
layer: number
matchWidthOrHeight: number
pixelsPerUnit: number
-scaleMode: number
+scaleMode: CanvasScaleMode
```
## CanvasScale — interface @experimental
@@ -4113,7 +4113,7 @@ shadowDistance: number
shadowExtent: number
shadowSoftness: number
sourceAngle: number
-type: number
+type: LightType
```
## LightType — enum @experimental
@@ -5202,7 +5202,7 @@ collisionEnabled: boolean
collisionFloor: number
collisionFriction: number
collisionLifetimeLoss: number
-colorEasing: number
+colorEasing: ParticleEasing
colorGradient: { stops: { t: number; color: Color; }[]; }
damping: number
duration: number
@@ -5225,13 +5225,13 @@ playOnStart: boolean
rate: number
rotationMax: number
rotationMin: number
-shape: number
+shape: EmitterShape
shapeAngle: number
shapeRadius: number
shapeSize: Vec3
-simulationSpace: number
+simulationSpace: SimulationSpace
sizeCurve: { keys: { t: number; v: number; }[]; }
-sizeEasing: number
+sizeEasing: ParticleEasing
speedMax: number
speedMin: number
spriteColumns: number
@@ -5244,7 +5244,7 @@ startSizeMin: number
subEmitter: number
subEmitterChance: number
subEmitterInheritVelocity: number
-subEmitterTrigger: number
+subEmitterTrigger: SubEmitterTrigger
texture: number
trailEnabled: boolean
trailMinDistance: number
@@ -5264,7 +5264,7 @@ enabled: boolean
falloff: boolean
radius: number
strength: number
-type: number
+type: ForceFieldType
```
## ParticlePlugin — class @experimental
@@ -6583,7 +6583,7 @@ BuiltinComponentDef<RigidBody3DData>
## RigidBody3DData — interface @experimental
```
angularDamping: number
-bodyType: number
+bodyType: BodyType
continuousCollision: boolean
enabled: boolean
fixedRotation: boolean
@@ -7167,7 +7167,7 @@ cornerRadius: number
enabled: boolean
layer: number
parallax: Vec2
-shapeType: number
+shapeType: ShapeType
size: Vec2
```
@@ -8254,12 +8254,12 @@ BuiltinComponentDef<TilemapLayerData>
cellSize: Vec2
hexSideLength: number
opacity: number
-orientation: number
+orientation: TilemapOrientation
originOffset: Vec2
parallaxFactor: Vec2
renderLayer: number
-staggerAxis: number
-staggerIndex: number
+staggerAxis: TilemapStaggerAxis
+staggerIndex: TilemapStaggerIndex
tileset: number
tilesetColumns: number
tintColor: Color
diff --git a/sdk/src/ecs/component.generated.ts b/sdk/src/ecs/component.generated.ts
index 50753d504..9fb5000ff 100644
--- a/sdk/src/ecs/component.generated.ts
+++ b/sdk/src/ecs/component.generated.ts
@@ -7,7 +7,7 @@
import type { AssetFieldType } from '../scene/scene';
import type { FieldMeta } from './component';
import type { Color, Entity, Quat, Vec2, Vec3, Vec4 } from '../types';
-import type { Dimension, Padding } from '../wasm/wasm.generated';
+import type { AlignContent, AlignItems, AlignSelf, BodyType, CanvasScaleMode, ClearFlags, Dimension, EmitterShape, FlexDirection, FlexWrap, ForceFieldType, JustifyContent, LightType, MaskMode, Padding, ParticleEasing, ProjectionType, ScrollMovement, ShapeType, SimulationSpace, SubEmitterTrigger, TextAlign, TilemapOrientation, TilemapStaggerAxis, TilemapStaggerIndex, UIDisplay, UIFillMethod, UIFillOrigin, UIPointerEvents, UIPositionType, UIVisualFit, UIVisualType } from '../wasm/wasm.generated';
/**
* Single-source-of-truth hash of the C++/TS boundary ABI (component
@@ -1073,7 +1073,7 @@ export interface BitmapTextData {
text: string;
color: Color;
fontSize: number;
- align: number;
+ align: TextAlign;
spacing: number;
parallax: Vec2;
layer: number;
@@ -1102,7 +1102,7 @@ export interface BoxCollider3DData {
}
export interface CameraData {
- projectionType: number;
+ projectionType: ProjectionType;
fov: number;
orthoSize: number;
nearPlane: number;
@@ -1111,7 +1111,7 @@ export interface CameraData {
isActive: boolean;
priority: number;
viewport: Vec4;
- clearFlags: number;
+ clearFlags: ClearFlags;
pixelPerfect: boolean;
cullingMask: number;
renderTarget: number;
@@ -1120,7 +1120,7 @@ export interface CameraData {
export interface CanvasData {
designResolution: Vec2;
pixelsPerUnit: number;
- scaleMode: number;
+ scaleMode: CanvasScaleMode;
matchWidthOrHeight: number;
backgroundColor: Color;
layer: number;
@@ -1224,11 +1224,11 @@ export interface DragonBonesAnimationData {
}
export interface FlexContainerData {
- direction: number;
- wrap: number;
- justifyContent: number;
- alignItems: number;
- alignContent: number;
+ direction: FlexDirection;
+ wrap: FlexWrap;
+ justifyContent: JustifyContent;
+ alignItems: AlignItems;
+ alignContent: AlignContent;
gap: Vec2;
padding: Padding;
}
@@ -1240,7 +1240,7 @@ export interface InteractableData {
}
export interface LightData {
- type: number;
+ type: LightType;
color: Color;
intensity: number;
radius: number;
@@ -1308,7 +1308,7 @@ export interface ParticleEmitterData {
maxParticles: number;
lifetimeMin: number;
lifetimeMax: number;
- shape: number;
+ shape: EmitterShape;
shapeRadius: number;
shapeSize: Vec3;
shapeAngle: number;
@@ -1320,10 +1320,10 @@ export interface ParticleEmitterData {
startSizeMax: number;
endSizeMin: number;
endSizeMax: number;
- sizeEasing: number;
+ sizeEasing: ParticleEasing;
startColor: Color;
endColor: Color;
- colorEasing: number;
+ colorEasing: ParticleEasing;
rotationMin: number;
rotationMax: number;
angularVelocityMin: number;
@@ -1342,9 +1342,9 @@ export interface ParticleEmitterData {
blendMode: number;
layer: number;
material: number;
- simulationSpace: number;
+ simulationSpace: SimulationSpace;
enabled: boolean;
- subEmitterTrigger: number;
+ subEmitterTrigger: SubEmitterTrigger;
subEmitterChance: number;
subEmitterInheritVelocity: number;
subEmitter: Entity;
@@ -1360,7 +1360,7 @@ export interface ParticleEmitterData {
}
export interface ParticleForceFieldData {
- type: number;
+ type: ForceFieldType;
strength: number;
radius: number;
direction: Vec3;
@@ -1369,7 +1369,7 @@ export interface ParticleForceFieldData {
}
export interface RigidBody2DData {
- bodyType: number;
+ bodyType: BodyType;
gravityScale: number;
linearDamping: number;
angularDamping: number;
@@ -1379,7 +1379,7 @@ export interface RigidBody2DData {
}
export interface RigidBody3DData {
- bodyType: number;
+ bodyType: BodyType;
gravityScale: number;
linearDamping: number;
angularDamping: number;
@@ -1407,7 +1407,7 @@ export interface ShadowCaster2DData {
}
export interface ShapeRendererData {
- shapeType: number;
+ shapeType: ShapeType;
color: Color;
size: Vec2;
cornerRadius: number;
@@ -1479,10 +1479,10 @@ export interface SpriteData {
*/
export interface TilemapLayerData {
cellSize: Vec2;
- orientation: number;
+ orientation: TilemapOrientation;
hexSideLength: number;
- staggerAxis: number;
- staggerIndex: number;
+ staggerAxis: TilemapStaggerAxis;
+ staggerIndex: TilemapStaggerIndex;
originOffset: Vec2;
tileset: number;
tilesetColumns: number;
@@ -1532,15 +1532,15 @@ export interface UIInteractionData {
export interface UIMaskData {
enabled: boolean;
- mode: number;
+ mode: MaskMode;
alphaCutoff: number;
}
export interface UINodeData {
- position: number;
- display: number;
+ position: UIPositionType;
+ display: UIDisplay;
opacity: number;
- pointerEvents: number;
+ pointerEvents: UIPointerEvents;
width: Dimension;
height: Dimension;
minWidth: Dimension;
@@ -1550,7 +1550,7 @@ export interface UINodeData {
flexGrow: number;
flexShrink: number;
flexBasis: Dimension;
- alignSelf: number;
+ alignSelf: AlignSelf;
marginLeft: Dimension;
marginTop: Dimension;
marginRight: Dimension;
@@ -1566,7 +1566,7 @@ export interface UIScrollData {
content: Entity;
horizontal: boolean;
vertical: boolean;
- movement: number;
+ movement: ScrollMovement;
wheelSpeed: number;
dragScroll: boolean;
decelerationRate: number;
@@ -1579,16 +1579,16 @@ export interface UIScrollData {
* @beta
*/
export interface UIVisualData {
- visualType: number;
+ visualType: UIVisualType;
texture: number;
color: Color;
- fit: number;
+ fit: UIVisualFit;
uvOffset: Vec2;
uvScale: Vec2;
sliceBorder: Vec4;
tileSize: Vec2;
- fillMethod: number;
- fillOrigin: number;
+ fillMethod: UIFillMethod;
+ fillOrigin: UIFillOrigin;
fillAmount: number;
material: number;
enabled: boolean;
diff --git a/sdk/tests/cpp-contract.test.ts b/sdk/tests/cpp-contract.test.ts
index efc620548..32b8f1b64 100644
--- a/sdk/tests/cpp-contract.test.ts
+++ b/sdk/tests/cpp-contract.test.ts
@@ -18,7 +18,7 @@
* handshake EHT already enforces for components.
*/
import { describe, it, expect } from 'vitest';
-import { readFileSync, existsSync } from 'node:fs';
+import { readFileSync, existsSync, readdirSync } from 'node:fs';
import { resolve } from 'node:path';
import { EasingType } from '../src/animation/Easing';
@@ -230,3 +230,33 @@ describe('C++ contract: enums that must stay their own declaration', () => {
});
});
});
+
+describe('C++ contract: a component field that IS an enum is typed as one', () => {
+ // The generator knows which enum a field is — its C++ type is one, or
+ // ES_PROPERTY names one. Answering `number` leaves the field unable to
+ // reject a value the engine has no meaning for.
+ it('no ES_PROPERTY(enum=) field is generated as a bare number', () => {
+ const data = readFileSync(
+ resolve(__dirname, '../src/ecs/component.generated.ts'), 'utf8');
+ const loose: string[] = [];
+ for (const dir of ['ecs/components', 'renderer/components']) {
+ const at = resolve(CPP, dir);
+ if (!existsSync(at)) continue;
+ for (const name of readdirSync(at).filter((f) => f.endsWith('.hpp'))) {
+ const lines = readFileSync(resolve(at, name), 'utf8').split('\n');
+ lines.forEach((line, i) => {
+ const enumName = /enum=([A-Za-z_]\w*)/.exec(line)?.[1];
+ if (!enumName) return;
+ const decl = lines.slice(i, i + 5)
+ .map((l) => /^\s*(?:u8|u16|u32|i8|i16|i32)\s+(\w+)\s*[{=]/.exec(l)?.[1])
+ .find(Boolean);
+ if (!decl) return;
+ if (!new RegExp(`^\\s*${decl}: ${enumName};$`, 'm').test(data)) {
+ loose.push(`${name}: ${decl} should be generated as ${enumName}`);
+ }
+ });
+ }
+ }
+ expect(loose).toEqual([]);
+ });
+});
diff --git a/tools/eht/generators/metadata.py b/tools/eht/generators/metadata.py
index 5f2d8b5b8..f008cebd4 100644
--- a/tools/eht/generators/metadata.py
+++ b/tools/eht/generators/metadata.py
@@ -246,6 +246,15 @@ class MetadataGenerator:
# './wasm.generated'.
_BASE_TS_TYPES = {'Entity', 'Vec2', 'Vec3', 'Vec4', 'Quat', 'Color'}
+ def _enum_ts_names(self) -> set:
+ """Every enum name the generated wasm module publishes, which is where a
+ component-data field's enum type is imported from."""
+ if self._enum_names_cache is None:
+ self._enum_names_cache = {e.name for e in self.types.enums}
+ return self._enum_names_cache
+
+ _enum_names_cache = None
+
def _data_ts_type(self, prop: Property) -> str:
"""TS type for a component-DATA field — the plain serialized shape, not the
embind/Registry shape `TypeSystem.to_typescript` produces (which maps vectors
@@ -265,8 +274,14 @@ class MetadataGenerator:
return 'number'
if 'entity_ref' in prop.annotations or self.types.is_entity(t):
return 'Entity'
+ # The enum, not the width it is stored in: the generator knows which one
+ # (either the field IS one, or ES_PROPERTY(enum=) names it) and dropping
+ # that leaves every C++-backed enum field in the SDK typed `number`.
if self.types.is_enum(t):
- return 'number'
+ return t.split('::')[-1]
+ named = prop.annotations.get('enum')
+ if named:
+ return named
if t in self.types.CUSTOM_STRUCTS:
return t
if t in ('glm::vec2', 'glm::uvec2'):
@@ -307,7 +322,7 @@ class MetadataGenerator:
base = ts[:-2] if ts.endswith('[]') else ts
if base in self._BASE_TS_TYPES:
used_base.add(base)
- elif base in self.types.CUSTOM_STRUCTS:
+ elif base in self.types.CUSTOM_STRUCTS or base in self._enum_ts_names():
used_struct.add(base)
field_lines.append(f' {prop.name}: {ts};')
# The SDK's tier, from ES_COMPONENT(stability=). It has to sit on the