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

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/sdk",
-  "version": "7.0.6-3808564125.commit-7a2650b",
+  "version": "7.0.6-3808892339.commit-e47ed81",
   "description": "",
   "main": "./index.js",
   "typings": "./index.d.ts",
@@ -25,5 +25,11 @@
     "@dcl/unity-renderer": "1.0.68557-20221221195847.commit-f743b85"
   },
   "minCliVersion": "3.14.1",
-  "commit": "7a2650b741ac5f5a5d3f00ac1c955e5f773d679a"
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "displayName": "SDK",
+    "tsconfig": "./tsconfig.json"
+  },
+  "commit": "e47ed813e0b5bd0e5fd6a0fd9e2eeb80783dab27"
 }

package/dist/playground-assets.d.ts

@@ -1,5 +1,7 @@
 import _m0 from 'protobufjs/minimal';
 
+export declare const AMOUNT_VERSION_AVAILABLE: number;
+
 export declare const Animator: AnimatorComponentDefinitionExtended;
 
 /**
@@ -1182,9 +1184,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;
@@ -1197,10 +1210,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;
 };
 
 /**
@@ -1695,6 +1711,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;
 
 /**
@@ -2463,6 +2481,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;
 
 /**
@@ -2913,10 +2938,10 @@ export declare const PBGltfContainer: {
 
 export declare interface PBMaterial {
     material?: {
-        $case: 'unlit';
+        $case: "unlit";
         unlit: PBMaterial_UnlitMaterial;
     } | {
-        $case: 'pbr';
+        $case: "pbr";
         pbr: PBMaterial_PbrMaterial;
     };
 }
@@ -2993,16 +3018,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;
     };
 }
@@ -3065,16 +3090,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;
     };
 }
@@ -3699,12 +3724,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 {
@@ -4067,6 +4092,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;
@@ -4364,10 +4394,10 @@ export declare type TextureHelper = {
 
 export declare interface TextureUnion {
     tex?: {
-        $case: 'texture';
+        $case: "texture";
         texture: Texture;
     } | {
-        $case: 'avatarTexture';
+        $case: "avatarTexture";
         avatarTexture: AvatarTexture;
     };
 }
@@ -4507,6 +4537,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/etc/playground-assets.api.json

@@ -172,6 +172,29 @@
       "name": "",
       "preserveMemberOrder": false,
       "members": [
+        {
+          "kind": "Variable",
+          "canonicalReference": "@dcl/playground-assets!AMOUNT_VERSION_AVAILABLE:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "AMOUNT_VERSION_AVAILABLE: "
+            },
+            {
+              "kind": "Content",
+              "text": "number"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "AMOUNT_VERSION_AVAILABLE",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!Animator:var",
@@ -8511,15 +8534,20 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@dcl/playground-assets!Entity:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * 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]\n *\n * 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\n *\n * Convertion from its compound numbers to entity: entity = (entityNumber & MAX_U16) | ((entityVersion & MAX_U16) << 16)\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "export declare type Entity = "
             },
+            {
+              "kind": "Reference",
+              "text": "uint32",
+              "canonicalReference": "@dcl/playground-assets!uint32:type"
+            },
             {
               "kind": "Content",
-              "text": "unknown"
+              "text": " & {\n    __entity_type: '';\n}"
             },
             {
               "kind": "Content",
@@ -8531,7 +8559,7 @@
           "name": "Entity",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 3
           }
         },
         {
@@ -8634,7 +8662,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    generateEntity(dynamic?: boolean): "
+              "text": "{\n    generateEntity(): "
             },
             {
               "kind": "Reference",
@@ -8679,7 +8707,34 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n}"
+              "text": ">;\n    entityVersion: (entity: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => number;\n    entityNumber: (entity: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => number;\n    entityId: (entityNumber: number, entityVersion: number) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
             },
             {
               "kind": "Content",
@@ -8689,7 +8744,7 @@
           "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
           "returnTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 12
+            "endIndex": 18
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -12260,6 +12315,33 @@
             "endIndex": 13
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@dcl/playground-assets!MASK_UPPER_16_ON_32:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "MASK_UPPER_16_ON_32 = "
+            },
+            {
+              "kind": "Content",
+              "text": "4294901760"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "MASK_UPPER_16_ON_32",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!Material:var",
@@ -19692,6 +19774,60 @@
             }
           ]
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@dcl/playground-assets!MAX_ENTITY_NUMBER:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "MAX_ENTITY_NUMBER = "
+            },
+            {
+              "kind": "Content",
+              "text": "65535"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "MAX_ENTITY_NUMBER",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@dcl/playground-assets!MAX_U16:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "MAX_U16 = "
+            },
+            {
+              "kind": "Content",
+              "text": "65535"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "MAX_U16",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!MeshCollider:var",
@@ -26398,7 +26534,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        $case: 'unlit';\n        unlit: "
+                  "text": "{\n        $case: \"unlit\";\n        unlit: "
                 },
                 {
                   "kind": "Reference",
@@ -26407,7 +26543,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'pbr';\n        pbr: "
+                  "text": ";\n    } | {\n        $case: \"pbr\";\n        pbr: "
                 },
                 {
                   "kind": "Reference",
@@ -26996,7 +27132,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        $case: 'box';\n        box: "
+                  "text": "{\n        $case: \"box\";\n        box: "
                 },
                 {
                   "kind": "Reference",
@@ -27005,7 +27141,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'sphere';\n        sphere: "
+                  "text": ";\n    } | {\n        $case: \"sphere\";\n        sphere: "
                 },
                 {
                   "kind": "Reference",
@@ -27014,7 +27150,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'cylinder';\n        cylinder: "
+                  "text": ";\n    } | {\n        $case: \"cylinder\";\n        cylinder: "
                 },
                 {
                   "kind": "Reference",
@@ -27023,7 +27159,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'plane';\n        plane: "
+                  "text": ";\n    } | {\n        $case: \"plane\";\n        plane: "
                 },
                 {
                   "kind": "Reference",
@@ -27641,7 +27777,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        $case: 'box';\n        box: "
+                  "text": "{\n        $case: \"box\";\n        box: "
                 },
                 {
                   "kind": "Reference",
@@ -27650,7 +27786,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'sphere';\n        sphere: "
+                  "text": ";\n    } | {\n        $case: \"sphere\";\n        sphere: "
                 },
                 {
                   "kind": "Reference",
@@ -27659,7 +27795,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'cylinder';\n        cylinder: "
+                  "text": ";\n    } | {\n        $case: \"cylinder\";\n        cylinder: "
                 },
                 {
                   "kind": "Reference",
@@ -27668,7 +27804,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'plane';\n        plane: "
+                  "text": ";\n    } | {\n        $case: \"plane\";\n        plane: "
                 },
                 {
                   "kind": "Reference",
@@ -34686,7 +34822,43 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    removeOnClick(entity: unknown): void;\n    removeOnPointerDown(entity: unknown): void;\n    removeOnPointerUp(entity: unknown): void;\n    onClick(entity: unknown, cb: import(\"../../systems/events\")."
+              "text": "{\n    removeOnClick(entity: import(\"../../engine\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): void;\n    removeOnPointerDown(entity: import(\"../../engine\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): void;\n    removeOnPointerUp(entity: import(\"../../engine\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): void;\n    onClick(entity: import(\"../../engine\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", cb: import(\"../../systems/events\")."
             },
             {
               "kind": "Reference",
@@ -34713,7 +34885,16 @@
             },
             {
               "kind": "Content",
-              "text": "> | undefined): void;\n    onPointerDown(entity: unknown, cb: import(\"../../systems/events\")."
+              "text": "> | undefined): void;\n    onPointerDown(entity: import(\"../../engine\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", cb: import(\"../../systems/events\")."
             },
             {
               "kind": "Reference",
@@ -34740,7 +34921,16 @@
             },
             {
               "kind": "Content",
-              "text": "> | undefined): void;\n    onPointerUp(entity: unknown, cb: import(\"../../systems/events\")."
+              "text": "> | undefined): void;\n    onPointerUp(entity: import(\"../../engine\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", cb: import(\"../../systems/events\")."
             },
             {
               "kind": "Reference",
@@ -34776,7 +34966,7 @@
           "name": "pointerEventsSystem",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 20
+            "endIndex": 32
           }
         },
         {
@@ -37789,6 +37979,33 @@
             "endIndex": 10
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@dcl/playground-assets!RESERVED_STATIC_ENTITIES:var",
+          "docComment": "/**\n * This first 512 entities are reserved by the renderer\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "RESERVED_STATIC_ENTITIES = "
+            },
+            {
+              "kind": "Content",
+              "text": "512"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "RESERVED_STATIC_ENTITIES",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@dcl/playground-assets!RPCSendableMessage:type",
@@ -40641,7 +40858,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        $case: 'texture';\n        texture: "
+                  "text": "{\n        $case: \"texture\";\n        texture: "
                 },
                 {
                   "kind": "Reference",
@@ -40650,7 +40867,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    } | {\n        $case: 'avatarTexture';\n        avatarTexture: "
+                  "text": ";\n    } | {\n        $case: \"avatarTexture\";\n        avatarTexture: "
                 },
                 {
                   "kind": "Reference",
@@ -41849,6 +42066,32 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@dcl/playground-assets!uint32:type",
+          "docComment": "/**\n * It only defines the type explicitly, no effects.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type uint32 = "
+            },
+            {
+              "kind": "Content",
+              "text": "number"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/engine/entity.d.ts",
+          "releaseTag": "Public",
+          "name": "uint32",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!UiText:var",