@dcl/playground-assets 7.0.6-3808797047.commit-ee7ea04 → 7.0.6-3808988484.commit-63d3e2c

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;
 
 /**
@@ -981,8 +983,8 @@ export declare type Color4Type = {
 };
 
 export declare type CommonProps = {
-    key: Key;
-    children: Children;
+    key?: Key;
+    children?: Children;
 };
 
 /**
@@ -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;
 };
 
 /**
@@ -1197,7 +1213,7 @@ export declare function EntityContainer(): {
 export declare type EntityPropTypes = {
     uiTransform?: UiTransformProps;
     uiBackground?: UiBackgroundProps;
-} & Listeners;
+} & Listeners & Pick<CommonProps, 'key'>;
 
 /**
  * Constant used to define the minimal number value in Babylon.js
@@ -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;
 
 /**
@@ -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;
@@ -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;
 
 /**
@@ -981,8 +983,8 @@ export declare type Color4Type = {
 };
 
 export declare type CommonProps = {
-    key: Key;
-    children: Children;
+    key?: Key;
+    children?: Children;
 };
 
 /**
@@ -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;
 };
 
 /**
@@ -1197,7 +1213,7 @@ export declare function EntityContainer(): {
 export declare type EntityPropTypes = {
     uiTransform?: UiTransformProps;
     uiBackground?: UiBackgroundProps;
-} & Listeners;
+} & Listeners & Pick<CommonProps, 'key'>;
 
 /**
  * Constant used to define the minimal number value in Babylon.js
@@ -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;
 
 /**
@@ -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;
@@ -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;
 
 /**
@@ -981,8 +983,8 @@ export declare type Color4Type = {
 };
 
 export declare type CommonProps = {
-    key: Key;
-    children: Children;
+    key?: Key;
+    children?: Children;
 };
 
 /**
@@ -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;
 };
 
 /**
@@ -1197,7 +1213,7 @@ export declare function EntityContainer(): {
 export declare type EntityPropTypes = {
     uiTransform?: UiTransformProps;
     uiBackground?: UiBackgroundProps;
-} & Listeners;
+} & Listeners & Pick<CommonProps, 'key'>;
 
 /**
  * Constant used to define the minimal number value in Babylon.js
@@ -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;
 
 /**
@@ -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;
@@ -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.js

@@ -14055,98 +14055,76 @@
         };
     }
 
-    var EntityUtils;
-    (function (EntityUtils) {
-        EntityUtils.MAX_ENTITIES = 0xffffffff;
-        EntityUtils.DYNAMIC_ENTITIES_START_AT = 100e3;
-        EntityUtils.RESERVED_STATIC_ENTITIES = 512;
-        EntityUtils.RESERVED_ENTITIES_RANGE = [
-            0,
-            EntityUtils.RESERVED_STATIC_ENTITIES - 1
-        ];
-        EntityUtils.STATIC_ENTITIES_RANGE = [
-            EntityUtils.RESERVED_STATIC_ENTITIES,
-            EntityUtils.MAX_ENTITIES
-            // DYNAMIC_ENTITIES_START_AT - 1
-        ];
-        EntityUtils.DYNAMIC_ENTITIES_RANGE = [
-            EntityUtils.DYNAMIC_ENTITIES_START_AT,
-            EntityUtils.MAX_ENTITIES
-        ];
-        function isInRange(entity, range) {
-            return entity >= range[0] && entity <= range[1];
-        }
-        // @internal
-        function isDynamicEntity(entity) {
-            return isInRange(entity, EntityUtils.DYNAMIC_ENTITIES_RANGE);
+    const MAX_U16 = 0xffff;
+    const MASK_UPPER_16_ON_32 = 0xffff0000;
+    const AMOUNT_VERSION_AVAILABLE = MAX_U16 + 1;
+    /**
+     * @public This first 512 entities are reserved by the renderer
+     */
+    const RESERVED_STATIC_ENTITIES = 512;
+    /**
+     * @public
+     */
+    const MAX_ENTITY_NUMBER = MAX_U16;
+    function EntityContainer() {
+        let entityCounter = RESERVED_STATIC_ENTITIES;
+        const usedEntities = new Set();
+        const removedEntities = new Map();
+        function entityVersion(entity) {
+            return (((entity & MASK_UPPER_16_ON_32) >> 16) & MAX_U16) >>> 0;
         }
-        EntityUtils.isDynamicEntity = isDynamicEntity;
-        function isStaticEntity(entity) {
-            return isInRange(entity, EntityUtils.STATIC_ENTITIES_RANGE);
+        function entityNumber(entity) {
+            return (entity & MAX_U16) >>> 0;
         }
-        EntityUtils.isStaticEntity = isStaticEntity;
-        function isReservedEntity(entity) {
-            return isInRange(entity, EntityUtils.RESERVED_ENTITIES_RANGE);
+        function entityId(entityNumber, entityVersion) {
+            return (((entityNumber & MAX_U16) | ((entityVersion & MAX_U16) << 16)) >>>
+                0);
         }
-        EntityUtils.isReservedEntity = isReservedEntity;
-    })(EntityUtils || (EntityUtils = {}));
-
-    function EntityContainer() {
-        const staticEntity = Entity(EntityUtils.STATIC_ENTITIES_RANGE);
-        const dynamicEntity = Entity(EntityUtils.DYNAMIC_ENTITIES_RANGE);
-        return {
-            generateEntity(dynamic = false) {
-                /* istanbul ignore next */
-                if (dynamic) {
-                    // Dynamic entities are not being used, but since we dont know the future of the dynamic entities
-                    // I prefer to comment the code instead of removing all the logic
-                    /* istanbul ignore next */
-                    return dynamicEntity.generateEntity();
-                }
-                else {
-                    return staticEntity.generateEntity();
-                }
-            },
-            removeEntity(entity) {
-                return (staticEntity.removeEntity(entity) || dynamicEntity.removeEntity(entity));
-            },
-            entityExists(entity) {
-                return (EntityUtils.isReservedEntity(entity) ||
-                    staticEntity.getExistingEntities().has(entity) ||
-                    dynamicEntity.getExistingEntities().has(entity));
-            },
-            getExistingEntities() {
-                return new Set([
-                    ...staticEntity.getExistingEntities(),
-                    ...dynamicEntity.getExistingEntities()
-                ]);
+        function generateNewEntity() {
+            if (entityCounter > MAX_ENTITY_NUMBER - 1) {
+                throw new Error(`It fails trying to generate an entity out of range ${MAX_ENTITY_NUMBER}.`);
             }
-        };
-    }
-    function Entity(range) {
-        function createEntity(entity) {
+            const entity = entityCounter++;
+            usedEntities.add(entity);
             return entity;
         }
-        let entityCounter = range[0];
-        const usedEntities = new Set();
         function generateEntity() {
-            if (entityCounter >= range[1]) {
-                throw new Error(`It fails trying to generate an entity out of range [${range[0]}, ${range[1]}].`);
+            if (usedEntities.size + RESERVED_STATIC_ENTITIES >= entityCounter) {
+                return generateNewEntity();
+            }
+            for (const [number, version] of removedEntities) {
+                if (version < MAX_U16) {
+                    const entity = entityId(number, version + 1);
+                    usedEntities.add(entity);
+                    removedEntities.delete(number);
+                    return entity;
+                }
             }
-            const entity = createEntity(entityCounter);
-            entityCounter++;
-            usedEntities.add(entity);
-            return entity;
+            return generateNewEntity();
         }
         function removeEntity(entity) {
-            return usedEntities.delete(entity);
+            const deleted = usedEntities.delete(entity);
+            if (deleted) {
+                removedEntities.set(entityNumber(entity), entityVersion(entity));
+            }
+            return deleted;
         }
         return {
+            generateEntity() {
+                return generateEntity();
+            },
+            removeEntity(entity) {
+                return removeEntity(entity);
+            },
+            entityExists(entity) {
+                return entity < RESERVED_STATIC_ENTITIES || usedEntities.has(entity);
+            },
             getExistingEntities() {
                 return new Set(usedEntities);
             },
-            generateEntity,
-            removeEntity
+            entityVersion,
+            entityNumber,
+            entityId
         };
     }
 
@@ -41180,6 +41158,7 @@
         await pollEvents(EngineApi.sendBatch);
     }
 
+    exports.AMOUNT_VERSION_AVAILABLE = AMOUNT_VERSION_AVAILABLE;
     exports.Animator = Animator;
     exports.AudioSource = AudioSource;
     exports.AudioStream = AudioStream;
@@ -41201,6 +41180,9 @@
     exports.GltfContainer = GltfContainer;
     exports.Input = Input;
     exports.Label = Label;
+    exports.MASK_UPPER_16_ON_32 = MASK_UPPER_16_ON_32;
+    exports.MAX_ENTITY_NUMBER = MAX_ENTITY_NUMBER;
+    exports.MAX_U16 = MAX_U16;
     exports.Material = Material;
     exports.MeshCollider = MeshCollider;
     exports.MeshRenderer = MeshRenderer;
@@ -41255,6 +41237,7 @@
     exports.PointerEventsResult = PointerEventsResult;
     exports.PointerLock = PointerLock;
     exports.RAD2DEG = RAD2DEG;
+    exports.RESERVED_STATIC_ENTITIES = RESERVED_STATIC_ENTITIES;
     exports.Raycast = Raycast;
     exports.RaycastHit = RaycastHit;
     exports.RaycastResult = RaycastResult;