@dcl/playground-assets 7.4.9 → 7.4.10-8394982680.commit-841a9e7

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

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.4.9",
+  "version": "7.4.10-8394982680.commit-841a9e7",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "1e8de58e5660b4247319ca8594821cd31e8e2e9a"
+  "commit": "841a9e70897121a4e420f983c632544bb7ff7f12"
 }

package/dist/playground-assets.d.ts

@@ -90,8 +90,32 @@ export declare namespace AppendValueOperation {
  */
 export declare function areConnected(parcels: Coords[]): boolean;
 
-/** @public */
-export declare const AudioSource: LastWriteWinElementSetComponentDefinition<PBAudioSource>;
+export declare const AudioSource: AudioSourceComponentDefinitionExtended;
+
+/**
+ * @public
+ */
+export declare interface AudioSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioSource> {
+    /**
+     * @public
+     *
+     * Set playing=true the sound `$name`
+     * @param entity - entity with AudioSource component
+     * @param src - the path to the sound to play
+     * @param resetCursor - the sound starts at 0 or continues from the current cursor position
+     * @returns true in successful playing, false if it doesn't find the AudioSource component
+     */
+    playSound(entity: Entity, src: string, resetCursor?: boolean): boolean;
+    /**
+     * @public
+     *
+     * Set playing=false all sounds
+     * @param entity - entity with AudioSource component
+     * @param resetCursor - the sound stops at 0 or at the current cursor position
+     * @returns true in successful stopping, false if it doesn't find the AudioSource component
+     */
+    stopSound(entity: Entity, resetCursor?: boolean): boolean;
+}
 
 /** @public */
 export declare const AudioStream: LastWriteWinElementSetComponentDefinition<PBAudioStream>;
@@ -1487,6 +1511,12 @@ export declare function createInputSystem(engine: IEngine): IInputSystem;
  */
 export declare function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSystem): PointerEventsSystem;
 
+/**
+ * @public
+ * @returns tween helper to be used on the scene
+ */
+export declare function createTweenSystem(engine: IEngine): TweenSystem;
+
 /**
  * Transform parenting: cyclic dependency checker
  * It checks only in modified Transforms
@@ -1989,6 +2019,7 @@ export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefin
  * @public
  */
 export declare interface IEngine {
+    _id: number;
     /**
      * @public
      * Increment the used entity counter and return the next one.
@@ -4126,6 +4157,13 @@ export declare namespace PBAnimator {
  * Note that the `audio_clip_url` is not actually a URL, but rather the path of a file bundled with
  * the scene and declared in its manifest. The name was chosen because the URL use-case will
  * eventually be supported.
+ *
+ * `playing=true` when it's previously `playing=true`
+ *  a) if clip is playing and `current_time` is NOT SET, the clip remains in the current `current_time`
+ *  b) if clip is stopped or `current_time` is set, the clip is played from the `current_time` (if set) or from the beginning
+ *
+ * If other property (volume, loop, pitch) is changed while playing, the clip is keep playing with the new properties
+ * Changing `audio_clip_url` while playing stops the current clip and plays the new one (as a new instance)
  */
 /**
  * @public
@@ -4141,6 +4179,10 @@ export declare interface PBAudioSource {
     pitch?: number | undefined;
     /** the clip path as given in the `files` array of the scene's manifest. */
     audioClipUrl: string;
+    /** specifies the current playback time of the clip in seconds (default: 0). */
+    currentTime?: number | undefined;
+    /** whether the audio plays at constant volume across the scene. */
+    global?: boolean | undefined;
 }
 
 /**

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
+      "packageVersion": "7.43.0"
     }
   ]
 }

package/etc/playground-assets.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.42.3",
+    "toolVersion": "7.43.0",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -883,12 +883,36 @@
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!AudioSource:var",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "AudioSource: "
             },
+            {
+              "kind": "Reference",
+              "text": "AudioSourceComponentDefinitionExtended",
+              "canonicalReference": "@dcl/playground-assets!AudioSourceComponentDefinitionExtended:interface"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/index.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "AudioSource",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@dcl/playground-assets!AudioSourceComponentDefinitionExtended:interface",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AudioSourceComponentDefinitionExtended extends "
+            },
             {
               "kind": "Reference",
               "text": "LastWriteWinElementSetComponentDefinition",
@@ -906,16 +930,164 @@
             {
               "kind": "Content",
               "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
-          "fileUrlPath": "../ecs/dist/components/generated/global.gen.d.ts",
-          "isReadonly": true,
+          "fileUrlPath": "../ecs/dist/components/extended/AudioSource.d.ts",
           "releaseTag": "Public",
-          "name": "AudioSource",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 5
-          }
+          "name": "AudioSourceComponentDefinitionExtended",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@dcl/playground-assets!AudioSourceComponentDefinitionExtended#playSound:member(1)",
+              "docComment": "/**\n * Set playing=true the sound `$name`\n *\n * @param entity - entity with AudioSource component\n *\n * @param src - the path to the sound to play\n *\n * @param resetCursor - the sound starts at 0 or continues from the current cursor position\n *\n * @returns true in successful playing, false if it doesn't find the AudioSource component\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "playSound(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", src: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", resetCursor?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "src",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "resetCursor",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "playSound"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@dcl/playground-assets!AudioSourceComponentDefinitionExtended#stopSound:member(1)",
+              "docComment": "/**\n * Set playing=false all sounds\n *\n * @param entity - entity with AudioSource component\n *\n * @param resetCursor - the sound stops at 0 or at the current cursor position\n *\n * @returns true in successful stopping, false if it doesn't find the AudioSource component\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stopSound(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", resetCursor?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "resetCursor",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "stopSound"
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            }
+          ]
         },
         {
           "kind": "Variable",
@@ -14805,6 +14977,53 @@
           ],
           "name": "createPointerEventsSystem"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!createTweenSystem:function(1)",
+          "docComment": "/**\n * @returns tween helper to be used on the scene\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function createTweenSystem(engine: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IEngine",
+              "canonicalReference": "@dcl/playground-assets!IEngine:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "TweenSystem",
+              "canonicalReference": "@dcl/playground-assets!TweenSystem:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/systems/tween.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "engine",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "createTweenSystem"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@dcl/playground-assets!cyclicParentingChecker:function(1)",
@@ -18899,6 +19118,33 @@
           "name": "IEngine",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!IEngine#_id:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "_id: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "_id",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@dcl/playground-assets!IEngine#addEntity:member(1)",
@@ -36120,6 +36366,60 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBAudioSource#currentTime:member",
+              "docComment": "/**\n * specifies the current playback time of the clip in seconds (default: 0).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "currentTime?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "currentTime",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBAudioSource#global:member",
+              "docComment": "/**\n * whether the audio plays at constant volume across the scene.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "global?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "global",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@dcl/playground-assets!PBAudioSource#loop:member",

package/etc/playground-assets.api.md

@@ -50,8 +50,16 @@ export namespace AppendValueOperation {
 // @public
 export function areConnected(parcels: Coords[]): boolean;
 
+// Warning: (ae-missing-release-tag) "AudioSource" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const AudioSource: AudioSourceComponentDefinitionExtended;
+
 // @public (undocumented)
-export const AudioSource: LastWriteWinElementSetComponentDefinition<PBAudioSource>;
+export interface AudioSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioSource> {
+    playSound(entity: Entity, src: string, resetCursor?: boolean): boolean;
+    stopSound(entity: Entity, resetCursor?: boolean): boolean;
+}
 
 // @public (undocumented)
 export const AudioStream: LastWriteWinElementSetComponentDefinition<PBAudioStream>;
@@ -751,6 +759,9 @@ export function createInputSystem(engine: IEngine): IInputSystem;
 // @public
 export function createPointerEventsSystem(engine: IEngine, inputSystem: IInputSystem): PointerEventsSystem;
 
+// @public (undocumented)
+export function createTweenSystem(engine: IEngine): TweenSystem;
+
 // Warning: (tsdoc-code-fence-closing-syntax) Unexpected characters after closing delimiter for code fence
 // Warning: (tsdoc-code-span-missing-delimiter) The code span is missing its closing backtick
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@params" is not defined in this configuration
@@ -1158,6 +1169,8 @@ export interface IEngine {
     // @alpha
     getEntityOrNullByName(label: string): Entity | null;
     getEntityState(entity: Entity): EntityState;
+    // (undocumented)
+    _id: number;
     readonly PlayerEntity: Entity;
     registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     // (undocumented)
@@ -2070,6 +2083,8 @@ export namespace PBAnimator {
 // @public (undocumented)
 export interface PBAudioSource {
     audioClipUrl: string;
+    currentTime?: number | undefined;
+    global?: boolean | undefined;
     loop?: boolean | undefined;
     pitch?: number | undefined;
     playing?: boolean | undefined;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.4.9",
+  "version": "7.4.10-8394982680.commit-841a9e7",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.4.9",
-    "@dcl/sdk": "7.4.9"
+    "@dcl/js-runtime": "7.4.10-8394982680.commit-841a9e7",
+    "@dcl/sdk": "7.4.10-8394982680.commit-841a9e7"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "1e8de58e5660b4247319ca8594821cd31e8e2e9a"
+  "commit": "841a9e70897121a4e420f983c632544bb7ff7f12"
 }