@dcl/playground-assets 7.0.6-3808564125.commit-7a2650b → 7.0.6-3808892339.commit-e47ed81

package/dist/alpha.d.ts

@@ -1,5 +1,7 @@
 import _m0 from 'protobufjs/minimal';
 
+export declare const AMOUNT_VERSION_AVAILABLE: number;
+
 export declare const Animator: AnimatorComponentDefinitionExtended;
 
 /**
@@ -1170,9 +1172,20 @@ export declare type EngineEvent<T extends IEventNames = IEventNames, V = IEvents
 };
 
 /**
- * @public
+ * @public The Entity is a number type, the cast is only for typescript, the final javascript code treat as a number
+ *  version  number
+ * [31...16][15...0]
+ *
+ * Convertion from entity to its compound numbers:
+ * To get the version => ((entity & MASK_UPPER_16_ON_32) >> 16) & MAX_U16
+ * To get the number  => entity & MAX_U16
+ *
+ * Convertion from its compound numbers to entity:
+ * entity = (entityNumber & MAX_U16) | ((entityVersion & MAX_U16) << 16)
  */
-export declare type Entity = unknown;
+export declare type Entity = uint32 & {
+    __entity_type: '';
+};
 
 export declare type EntityComponents = {
     uiTransform: PBUiTransform;
@@ -1185,10 +1198,13 @@ export declare type EntityComponents = {
 };
 
 export declare function EntityContainer(): {
-    generateEntity(dynamic?: boolean): Entity;
+    generateEntity(): Entity;
     removeEntity(entity: Entity): boolean;
     entityExists(entity: Entity): boolean;
     getExistingEntities(): Set<Entity>;
+    entityVersion: (entity: Entity) => number;
+    entityNumber: (entity: Entity) => number;
+    entityId: (entityNumber: number, entityVersion: number) => Entity;
 };
 
 /**
@@ -1683,6 +1699,8 @@ export declare type MapResult<T extends Spec> = ToOptional<{
     [K in keyof T]: T[K] extends ISchema ? ReturnType<T[K]['deserialize']> : T[K] extends Spec ? MapResult<T[K]> : never;
 }>;
 
+export declare const MASK_UPPER_16_ON_32 = 4294901760;
+
 export declare const Material: MaterialComponentDefinitionExtended;
 
 /**
@@ -2451,6 +2469,13 @@ export declare namespace Matrix {
     export function toggleProjectionMatrixHandInPlace(self: MutableMatrix): void;
 }
 
+/**
+ * @public
+ */
+export declare const MAX_ENTITY_NUMBER = 65535;
+
+export declare const MAX_U16 = 65535;
+
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 
 /**
@@ -2901,10 +2926,10 @@ export declare const PBGltfContainer: {
 
 export declare interface PBMaterial {
     material?: {
-        $case: 'unlit';
+        $case: "unlit";
         unlit: PBMaterial_UnlitMaterial;
     } | {
-        $case: 'pbr';
+        $case: "pbr";
         pbr: PBMaterial_PbrMaterial;
     };
 }
@@ -2981,16 +3006,16 @@ export declare interface PBMeshCollider {
     /** default = ColliderLayer.Physics | ColliderLayer.Pointer */
     collisionMask?: number | undefined;
     mesh?: {
-        $case: 'box';
+        $case: "box";
         box: PBMeshCollider_BoxMesh;
     } | {
-        $case: 'sphere';
+        $case: "sphere";
         sphere: PBMeshCollider_SphereMesh;
     } | {
-        $case: 'cylinder';
+        $case: "cylinder";
         cylinder: PBMeshCollider_CylinderMesh;
     } | {
-        $case: 'plane';
+        $case: "plane";
         plane: PBMeshCollider_PlaneMesh;
     };
 }
@@ -3053,16 +3078,16 @@ export declare const PBMeshCollider_SphereMesh: {
 
 export declare interface PBMeshRenderer {
     mesh?: {
-        $case: 'box';
+        $case: "box";
         box: PBMeshRenderer_BoxMesh;
     } | {
-        $case: 'sphere';
+        $case: "sphere";
         sphere: PBMeshRenderer_SphereMesh;
     } | {
-        $case: 'cylinder';
+        $case: "cylinder";
         cylinder: PBMeshRenderer_CylinderMesh;
     } | {
-        $case: 'plane';
+        $case: "plane";
         plane: PBMeshRenderer_PlaneMesh;
     };
 }
@@ -3687,12 +3712,12 @@ export declare const PointerEventsResult: ComponentDefinition<PBPointerEventsRes
 export declare type PointerEventsSystem = ReturnType<typeof createPointerEventSystem>;
 
 export declare const pointerEventsSystem: {
-    removeOnClick(entity: unknown): void;
-    removeOnPointerDown(entity: unknown): void;
-    removeOnPointerUp(entity: unknown): void;
-    onClick(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerDown(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerUp(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    removeOnClick(entity: Entity): void;
+    removeOnPointerDown(entity: Entity): void;
+    removeOnPointerUp(entity: Entity): void;
+    onClick(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
 };
 
 export declare const enum PointerEventType {
@@ -4055,6 +4080,11 @@ export declare type ReceiveMessage = {
     messageBuffer: Uint8Array;
 };
 
+/**
+ * @public This first 512 entities are reserved by the renderer
+ */
+export declare const RESERVED_STATIC_ENTITIES = 512;
+
 export declare type RPCSendableMessage = {
     jsonrpc: '2.0';
     id: number;
@@ -4352,10 +4382,10 @@ export declare type TextureHelper = {
 
 export declare interface TextureUnion {
     tex?: {
-        $case: 'texture';
+        $case: "texture";
         texture: Texture;
     } | {
-        $case: 'avatarTexture';
+        $case: "avatarTexture";
         avatarTexture: AvatarTexture;
     };
 }
@@ -4495,6 +4525,11 @@ export declare type UiInputProps = PBUiInput & {
 /** @public */
 export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
 
+/**
+ * @public It only defines the type explicitly, no effects.
+ */
+export declare type uint32 = number;
+
 /** @public */
 export declare const UiText: ComponentDefinition<PBUiText>;
 

package/dist/beta.d.ts

@@ -1,5 +1,7 @@
 import _m0 from 'protobufjs/minimal';
 
+export declare const AMOUNT_VERSION_AVAILABLE: number;
+
 export declare const Animator: AnimatorComponentDefinitionExtended;
 
 /**
@@ -1170,9 +1172,20 @@ export declare type EngineEvent<T extends IEventNames = IEventNames, V = IEvents
 };
 
 /**
- * @public
+ * @public The Entity is a number type, the cast is only for typescript, the final javascript code treat as a number
+ *  version  number
+ * [31...16][15...0]
+ *
+ * Convertion from entity to its compound numbers:
+ * To get the version => ((entity & MASK_UPPER_16_ON_32) >> 16) & MAX_U16
+ * To get the number  => entity & MAX_U16
+ *
+ * Convertion from its compound numbers to entity:
+ * entity = (entityNumber & MAX_U16) | ((entityVersion & MAX_U16) << 16)
  */
-export declare type Entity = unknown;
+export declare type Entity = uint32 & {
+    __entity_type: '';
+};
 
 export declare type EntityComponents = {
     uiTransform: PBUiTransform;
@@ -1185,10 +1198,13 @@ export declare type EntityComponents = {
 };
 
 export declare function EntityContainer(): {
-    generateEntity(dynamic?: boolean): Entity;
+    generateEntity(): Entity;
     removeEntity(entity: Entity): boolean;
     entityExists(entity: Entity): boolean;
     getExistingEntities(): Set<Entity>;
+    entityVersion: (entity: Entity) => number;
+    entityNumber: (entity: Entity) => number;
+    entityId: (entityNumber: number, entityVersion: number) => Entity;
 };
 
 /**
@@ -1683,6 +1699,8 @@ export declare type MapResult<T extends Spec> = ToOptional<{
     [K in keyof T]: T[K] extends ISchema ? ReturnType<T[K]['deserialize']> : T[K] extends Spec ? MapResult<T[K]> : never;
 }>;
 
+export declare const MASK_UPPER_16_ON_32 = 4294901760;
+
 export declare const Material: MaterialComponentDefinitionExtended;
 
 /**
@@ -2451,6 +2469,13 @@ export declare namespace Matrix {
     export function toggleProjectionMatrixHandInPlace(self: MutableMatrix): void;
 }
 
+/**
+ * @public
+ */
+export declare const MAX_ENTITY_NUMBER = 65535;
+
+export declare const MAX_U16 = 65535;
+
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 
 /**
@@ -2901,10 +2926,10 @@ export declare const PBGltfContainer: {
 
 export declare interface PBMaterial {
     material?: {
-        $case: 'unlit';
+        $case: "unlit";
         unlit: PBMaterial_UnlitMaterial;
     } | {
-        $case: 'pbr';
+        $case: "pbr";
         pbr: PBMaterial_PbrMaterial;
     };
 }
@@ -2981,16 +3006,16 @@ export declare interface PBMeshCollider {
     /** default = ColliderLayer.Physics | ColliderLayer.Pointer */
     collisionMask?: number | undefined;
     mesh?: {
-        $case: 'box';
+        $case: "box";
         box: PBMeshCollider_BoxMesh;
     } | {
-        $case: 'sphere';
+        $case: "sphere";
         sphere: PBMeshCollider_SphereMesh;
     } | {
-        $case: 'cylinder';
+        $case: "cylinder";
         cylinder: PBMeshCollider_CylinderMesh;
     } | {
-        $case: 'plane';
+        $case: "plane";
         plane: PBMeshCollider_PlaneMesh;
     };
 }
@@ -3053,16 +3078,16 @@ export declare const PBMeshCollider_SphereMesh: {
 
 export declare interface PBMeshRenderer {
     mesh?: {
-        $case: 'box';
+        $case: "box";
         box: PBMeshRenderer_BoxMesh;
     } | {
-        $case: 'sphere';
+        $case: "sphere";
         sphere: PBMeshRenderer_SphereMesh;
     } | {
-        $case: 'cylinder';
+        $case: "cylinder";
         cylinder: PBMeshRenderer_CylinderMesh;
     } | {
-        $case: 'plane';
+        $case: "plane";
         plane: PBMeshRenderer_PlaneMesh;
     };
 }
@@ -3687,12 +3712,12 @@ export declare const PointerEventsResult: ComponentDefinition<PBPointerEventsRes
 export declare type PointerEventsSystem = ReturnType<typeof createPointerEventSystem>;
 
 export declare const pointerEventsSystem: {
-    removeOnClick(entity: unknown): void;
-    removeOnPointerDown(entity: unknown): void;
-    removeOnPointerUp(entity: unknown): void;
-    onClick(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerDown(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerUp(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    removeOnClick(entity: Entity): void;
+    removeOnPointerDown(entity: Entity): void;
+    removeOnPointerUp(entity: Entity): void;
+    onClick(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
 };
 
 export declare const enum PointerEventType {
@@ -4055,6 +4080,11 @@ export declare type ReceiveMessage = {
     messageBuffer: Uint8Array;
 };
 
+/**
+ * @public This first 512 entities are reserved by the renderer
+ */
+export declare const RESERVED_STATIC_ENTITIES = 512;
+
 export declare type RPCSendableMessage = {
     jsonrpc: '2.0';
     id: number;
@@ -4352,10 +4382,10 @@ export declare type TextureHelper = {
 
 export declare interface TextureUnion {
     tex?: {
-        $case: 'texture';
+        $case: "texture";
         texture: Texture;
     } | {
-        $case: 'avatarTexture';
+        $case: "avatarTexture";
         avatarTexture: AvatarTexture;
     };
 }
@@ -4495,6 +4525,11 @@ export declare type UiInputProps = PBUiInput & {
 /** @public */
 export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
 
+/**
+ * @public It only defines the type explicitly, no effects.
+ */
+export declare type uint32 = number;
+
 /** @public */
 export declare const UiText: ComponentDefinition<PBUiText>;
 

package/dist/index.bundled.d.ts

@@ -1,5 +1,7 @@
 import _m0 from 'protobufjs/minimal';
 
+export declare const AMOUNT_VERSION_AVAILABLE: number;
+
 export declare const Animator: AnimatorComponentDefinitionExtended;
 
 /**
@@ -1170,9 +1172,20 @@ export declare type EngineEvent<T extends IEventNames = IEventNames, V = IEvents
 };
 
 /**
- * @public
+ * @public The Entity is a number type, the cast is only for typescript, the final javascript code treat as a number
+ *  version  number
+ * [31...16][15...0]
+ *
+ * Convertion from entity to its compound numbers:
+ * To get the version => ((entity & MASK_UPPER_16_ON_32) >> 16) & MAX_U16
+ * To get the number  => entity & MAX_U16
+ *
+ * Convertion from its compound numbers to entity:
+ * entity = (entityNumber & MAX_U16) | ((entityVersion & MAX_U16) << 16)
  */
-export declare type Entity = unknown;
+export declare type Entity = uint32 & {
+    __entity_type: '';
+};
 
 export declare type EntityComponents = {
     uiTransform: PBUiTransform;
@@ -1185,10 +1198,13 @@ export declare type EntityComponents = {
 };
 
 export declare function EntityContainer(): {
-    generateEntity(dynamic?: boolean): Entity;
+    generateEntity(): Entity;
     removeEntity(entity: Entity): boolean;
     entityExists(entity: Entity): boolean;
     getExistingEntities(): Set<Entity>;
+    entityVersion: (entity: Entity) => number;
+    entityNumber: (entity: Entity) => number;
+    entityId: (entityNumber: number, entityVersion: number) => Entity;
 };
 
 /**
@@ -1683,6 +1699,8 @@ export declare type MapResult<T extends Spec> = ToOptional<{
     [K in keyof T]: T[K] extends ISchema ? ReturnType<T[K]['deserialize']> : T[K] extends Spec ? MapResult<T[K]> : never;
 }>;
 
+export declare const MASK_UPPER_16_ON_32 = 4294901760;
+
 export declare const Material: MaterialComponentDefinitionExtended;
 
 /**
@@ -2451,6 +2469,13 @@ export declare namespace Matrix {
     export function toggleProjectionMatrixHandInPlace(self: MutableMatrix): void;
 }
 
+/**
+ * @public
+ */
+export declare const MAX_ENTITY_NUMBER = 65535;
+
+export declare const MAX_U16 = 65535;
+
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 
 /**
@@ -2901,10 +2926,10 @@ export declare const PBGltfContainer: {
 
 export declare interface PBMaterial {
     material?: {
-        $case: 'unlit';
+        $case: "unlit";
         unlit: PBMaterial_UnlitMaterial;
     } | {
-        $case: 'pbr';
+        $case: "pbr";
         pbr: PBMaterial_PbrMaterial;
     };
 }
@@ -2981,16 +3006,16 @@ export declare interface PBMeshCollider {
     /** default = ColliderLayer.Physics | ColliderLayer.Pointer */
     collisionMask?: number | undefined;
     mesh?: {
-        $case: 'box';
+        $case: "box";
         box: PBMeshCollider_BoxMesh;
     } | {
-        $case: 'sphere';
+        $case: "sphere";
         sphere: PBMeshCollider_SphereMesh;
     } | {
-        $case: 'cylinder';
+        $case: "cylinder";
         cylinder: PBMeshCollider_CylinderMesh;
     } | {
-        $case: 'plane';
+        $case: "plane";
         plane: PBMeshCollider_PlaneMesh;
     };
 }
@@ -3053,16 +3078,16 @@ export declare const PBMeshCollider_SphereMesh: {
 
 export declare interface PBMeshRenderer {
     mesh?: {
-        $case: 'box';
+        $case: "box";
         box: PBMeshRenderer_BoxMesh;
     } | {
-        $case: 'sphere';
+        $case: "sphere";
         sphere: PBMeshRenderer_SphereMesh;
     } | {
-        $case: 'cylinder';
+        $case: "cylinder";
         cylinder: PBMeshRenderer_CylinderMesh;
     } | {
-        $case: 'plane';
+        $case: "plane";
         plane: PBMeshRenderer_PlaneMesh;
     };
 }
@@ -3687,12 +3712,12 @@ export declare const PointerEventsResult: ComponentDefinition<PBPointerEventsRes
 export declare type PointerEventsSystem = ReturnType<typeof createPointerEventSystem>;
 
 export declare const pointerEventsSystem: {
-    removeOnClick(entity: unknown): void;
-    removeOnPointerDown(entity: unknown): void;
-    removeOnPointerUp(entity: unknown): void;
-    onClick(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerDown(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerUp(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    removeOnClick(entity: Entity): void;
+    removeOnPointerDown(entity: Entity): void;
+    removeOnPointerUp(entity: Entity): void;
+    onClick(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
 };
 
 export declare const enum PointerEventType {
@@ -4055,6 +4080,11 @@ export declare type ReceiveMessage = {
     messageBuffer: Uint8Array;
 };
 
+/**
+ * @public This first 512 entities are reserved by the renderer
+ */
+export declare const RESERVED_STATIC_ENTITIES = 512;
+
 export declare type RPCSendableMessage = {
     jsonrpc: '2.0';
     id: number;
@@ -4352,10 +4382,10 @@ export declare type TextureHelper = {
 
 export declare interface TextureUnion {
     tex?: {
-        $case: 'texture';
+        $case: "texture";
         texture: Texture;
     } | {
-        $case: 'avatarTexture';
+        $case: "avatarTexture";
         avatarTexture: AvatarTexture;
     };
 }
@@ -4495,6 +4525,11 @@ export declare type UiInputProps = PBUiInput & {
 /** @public */
 export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
 
+/**
+ * @public It only defines the type explicitly, no effects.
+ */
+export declare type uint32 = number;
+
 /** @public */
 export declare const UiText: ComponentDefinition<PBUiText>;