@dcl/ecs 7.4.10-8392909116.commit-6487246 → 7.4.10-8394982680.commit-841a9e7

package/dist/components/extended/AudioSource.d.ts

@@ -0,0 +1,28 @@
+import { Entity, IEngine } from '../../engine';
+import { LastWriteWinElementSetComponentDefinition } from '../../engine/component';
+import { PBAudioSource } from '../generated/pb/decentraland/sdk/components/audio_source.gen';
+/**
+ * @public
+ */
+export 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;
+}
+export declare function defineAudioSourceComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): AudioSourceComponentDefinitionExtended;

package/dist/components/extended/AudioSource.js

@@ -0,0 +1,26 @@
+import { AudioSource } from '../generated/index.gen';
+export function defineAudioSourceComponent(engine) {
+    const theComponent = AudioSource(engine);
+    return {
+        ...theComponent,
+        playSound(entity, src, resetCursor = true) {
+            // Get the mutable to modify
+            const audioSource = theComponent.getMutableOrNull(entity);
+            if (!audioSource)
+                return false;
+            audioSource.audioClipUrl = src;
+            audioSource.playing = true;
+            audioSource.currentTime = resetCursor ? 0 : audioSource.currentTime;
+            return true;
+        },
+        stopSound(entity, resetCursor = true) {
+            // Get the mutable to modify
+            const audioSource = theComponent.getMutableOrNull(entity);
+            if (!audioSource)
+                return false;
+            audioSource.playing = false;
+            audioSource.currentTime = resetCursor ? 0 : audioSource.currentTime;
+            return true;
+        }
+    };
+}

package/dist/components/generated/pb/decentraland/sdk/components/audio_source.gen.d.ts

@@ -9,6 +9,13 @@ import _m0 from "protobufjs/minimal";
  * 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
@@ -24,6 +31,10 @@ export 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;
 }
 /**
  * @public

package/dist/components/generated/pb/decentraland/sdk/components/audio_source.gen.js

@@ -2,7 +2,15 @@
 import _m0 from "protobufjs/minimal";
 const protobufPackageSarasa = "decentraland.sdk.components";
 function createBasePBAudioSource() {
-    return { playing: undefined, volume: undefined, loop: undefined, pitch: undefined, audioClipUrl: "" };
+    return {
+        playing: undefined,
+        volume: undefined,
+        loop: undefined,
+        pitch: undefined,
+        audioClipUrl: "",
+        currentTime: undefined,
+        global: undefined,
+    };
 }
 /**
  * @public
@@ -25,6 +33,12 @@ export var PBAudioSource;
         if (message.audioClipUrl !== "") {
             writer.uint32(42).string(message.audioClipUrl);
         }
+        if (message.currentTime !== undefined) {
+            writer.uint32(53).float(message.currentTime);
+        }
+        if (message.global !== undefined) {
+            writer.uint32(56).bool(message.global);
+        }
         return writer;
     }
     PBAudioSource.encode = encode;
@@ -65,6 +79,18 @@ export var PBAudioSource;
                     }
                     message.audioClipUrl = reader.string();
                     continue;
+                case 6:
+                    if (tag !== 53) {
+                        break;
+                    }
+                    message.currentTime = reader.float();
+                    continue;
+                case 7:
+                    if (tag !== 56) {
+                        break;
+                    }
+                    message.global = reader.bool();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;

package/dist/components/index.d.ts

@@ -1,6 +1,7 @@
 import { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition } from '../engine/component';
 import { IEngine } from '../engine/types';
 import { AnimatorComponentDefinitionExtended } from './extended/Animator';
+import { AudioSourceComponentDefinitionExtended } from './extended/AudioSource';
 import { MaterialComponentDefinitionExtended } from './extended/Material';
 import { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
 import { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
@@ -16,6 +17,7 @@ export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetCompone
 export declare const Transform: LwwComponentGetter<TransformComponentExtended>;
 export declare const Material: LwwComponentGetter<MaterialComponentDefinitionExtended>;
 export declare const Animator: LwwComponentGetter<AnimatorComponentDefinitionExtended>;
+export declare const AudioSource: LwwComponentGetter<AudioSourceComponentDefinitionExtended>;
 export declare const MeshRenderer: LwwComponentGetter<MeshRendererComponentDefinitionExtended>;
 export declare const MeshCollider: LwwComponentGetter<MeshColliderComponentDefinitionExtended>;
 export declare const Tween: LwwComponentGetter<TweenComponentDefinitionExtended>;

package/dist/components/index.js

@@ -1,4 +1,5 @@
 import { defineAnimatorComponent } from './extended/Animator';
+import { defineAudioSourceComponent } from './extended/AudioSource';
 import { defineMaterialComponent } from './extended/Material';
 import { defineMeshColliderComponent } from './extended/MeshCollider';
 import { defineMeshRendererComponent } from './extended/MeshRenderer';
@@ -16,6 +17,8 @@ export const Material = (engine) => defineMaterialComponent(engine);
 /* @__PURE__ */
 export const Animator = (engine) => defineAnimatorComponent(engine);
 /* @__PURE__ */
+export const AudioSource = (engine) => defineAudioSourceComponent(engine);
+/* @__PURE__ */
 export const MeshRenderer = (engine) => defineMeshRendererComponent(engine);
 /* @__PURE__ */
 export const MeshCollider = (engine) => defineMeshColliderComponent(engine);

package/dist/components/types.d.ts

@@ -1,4 +1,5 @@
 export type { AnimatorComponentDefinitionExtended } from './extended/Animator';
+export type { AudioSourceComponentDefinitionExtended } from './extended/AudioSource';
 export type { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
 export type { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
 export type { TextureHelper, MaterialComponentDefinitionExtended } from './extended/Material';

package/dist/composite/proto/gen/composite.gen.js

@@ -84,7 +84,7 @@ export var CompositeComponent;
         if (message.jsonSchema !== undefined) {
             Value.encode(Value.wrap(message.jsonSchema), writer.uint32(18).fork()).ldelim();
         }
-        (message.data).forEach((value, key) => {
+        message.data.forEach((value, key) => {
             CompositeComponent_DataEntry.encode({ key: key, value }, writer.uint32(26).fork()).ldelim();
         });
         return writer;

package/dist/composite/proto/gen/google/protobuf/struct.gen.js

@@ -47,7 +47,7 @@ function createBaseStruct() {
 export var Struct;
 (function (Struct) {
     function encode(message, writer = _m0.Writer.create()) {
-        (message.fields).forEach((value, key) => {
+        message.fields.forEach((value, key) => {
             if (value !== undefined) {
                 Struct_FieldsEntry.encode({ key: key, value }, writer.uint32(10).fork()).ldelim();
             }

package/dist/index.d.ts

@@ -11,10 +11,11 @@ export * from './systems/async-task';
 export * from './systems/tween';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent } from './components/types';
 import { NameComponent } from './components/manual/Name';
 export declare const Transform: TransformComponentExtended;
 export declare const Animator: AnimatorComponentDefinitionExtended;
+export declare const AudioSource: AudioSourceComponentDefinitionExtended;
 export declare const Material: MaterialComponentDefinitionExtended;
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;

package/dist/index.js

@@ -20,6 +20,7 @@ import { engine } from './runtime/initialization';
 // export components for global engine
 export const Transform = /* @__PURE__*/ components.Transform(engine);
 export const Animator = /* @__PURE__*/ components.Animator(engine);
+export const AudioSource = /* @__PURE__*/ components.AudioSource(engine);
 export const Material = /* @__PURE__*/ components.Material(engine);
 export const MeshRenderer = /* @__PURE__*/ components.MeshRenderer(engine);
 export const MeshCollider = /* @__PURE__*/ components.MeshCollider(engine);

package/dist-cjs/components/extended/AudioSource.d.ts

@@ -0,0 +1,28 @@
+import { Entity, IEngine } from '../../engine';
+import { LastWriteWinElementSetComponentDefinition } from '../../engine/component';
+import { PBAudioSource } from '../generated/pb/decentraland/sdk/components/audio_source.gen';
+/**
+ * @public
+ */
+export 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;
+}
+export declare function defineAudioSourceComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): AudioSourceComponentDefinitionExtended;

package/dist-cjs/components/extended/AudioSource.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineAudioSourceComponent = void 0;
+const index_gen_1 = require("../generated/index.gen");
+function defineAudioSourceComponent(engine) {
+    const theComponent = (0, index_gen_1.AudioSource)(engine);
+    return {
+        ...theComponent,
+        playSound(entity, src, resetCursor = true) {
+            // Get the mutable to modify
+            const audioSource = theComponent.getMutableOrNull(entity);
+            if (!audioSource)
+                return false;
+            audioSource.audioClipUrl = src;
+            audioSource.playing = true;
+            audioSource.currentTime = resetCursor ? 0 : audioSource.currentTime;
+            return true;
+        },
+        stopSound(entity, resetCursor = true) {
+            // Get the mutable to modify
+            const audioSource = theComponent.getMutableOrNull(entity);
+            if (!audioSource)
+                return false;
+            audioSource.playing = false;
+            audioSource.currentTime = resetCursor ? 0 : audioSource.currentTime;
+            return true;
+        }
+    };
+}
+exports.defineAudioSourceComponent = defineAudioSourceComponent;

package/dist-cjs/components/generated/pb/decentraland/sdk/components/audio_source.gen.d.ts

@@ -9,6 +9,13 @@ import _m0 from "protobufjs/minimal";
  * 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
@@ -24,6 +31,10 @@ export 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;
 }
 /**
  * @public

package/dist-cjs/components/generated/pb/decentraland/sdk/components/audio_source.gen.js

@@ -8,7 +8,15 @@ exports.PBAudioSource = void 0;
 const minimal_1 = __importDefault(require("protobufjs/minimal"));
 const protobufPackageSarasa = "decentraland.sdk.components";
 function createBasePBAudioSource() {
-    return { playing: undefined, volume: undefined, loop: undefined, pitch: undefined, audioClipUrl: "" };
+    return {
+        playing: undefined,
+        volume: undefined,
+        loop: undefined,
+        pitch: undefined,
+        audioClipUrl: "",
+        currentTime: undefined,
+        global: undefined,
+    };
 }
 /**
  * @public
@@ -31,6 +39,12 @@ var PBAudioSource;
         if (message.audioClipUrl !== "") {
             writer.uint32(42).string(message.audioClipUrl);
         }
+        if (message.currentTime !== undefined) {
+            writer.uint32(53).float(message.currentTime);
+        }
+        if (message.global !== undefined) {
+            writer.uint32(56).bool(message.global);
+        }
         return writer;
     }
     PBAudioSource.encode = encode;
@@ -71,6 +85,18 @@ var PBAudioSource;
                     }
                     message.audioClipUrl = reader.string();
                     continue;
+                case 6:
+                    if (tag !== 53) {
+                        break;
+                    }
+                    message.currentTime = reader.float();
+                    continue;
+                case 7:
+                    if (tag !== 56) {
+                        break;
+                    }
+                    message.global = reader.bool();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;

package/dist-cjs/components/index.d.ts

@@ -1,6 +1,7 @@
 import { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition } from '../engine/component';
 import { IEngine } from '../engine/types';
 import { AnimatorComponentDefinitionExtended } from './extended/Animator';
+import { AudioSourceComponentDefinitionExtended } from './extended/AudioSource';
 import { MaterialComponentDefinitionExtended } from './extended/Material';
 import { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
 import { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
@@ -16,6 +17,7 @@ export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetCompone
 export declare const Transform: LwwComponentGetter<TransformComponentExtended>;
 export declare const Material: LwwComponentGetter<MaterialComponentDefinitionExtended>;
 export declare const Animator: LwwComponentGetter<AnimatorComponentDefinitionExtended>;
+export declare const AudioSource: LwwComponentGetter<AudioSourceComponentDefinitionExtended>;
 export declare const MeshRenderer: LwwComponentGetter<MeshRendererComponentDefinitionExtended>;
 export declare const MeshCollider: LwwComponentGetter<MeshColliderComponentDefinitionExtended>;
 export declare const Tween: LwwComponentGetter<TweenComponentDefinitionExtended>;

package/dist-cjs/components/index.js

@@ -17,8 +17,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Name = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.Animator = exports.Material = exports.Transform = void 0;
+exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Name = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.AudioSource = exports.Animator = exports.Material = exports.Transform = void 0;
 const Animator_1 = require("./extended/Animator");
+const AudioSource_1 = require("./extended/AudioSource");
 const Material_1 = require("./extended/Material");
 const MeshCollider_1 = require("./extended/MeshCollider");
 const MeshRenderer_1 = require("./extended/MeshRenderer");
@@ -39,6 +40,9 @@ exports.Material = Material;
 const Animator = (engine) => (0, Animator_1.defineAnimatorComponent)(engine);
 exports.Animator = Animator;
 /* @__PURE__ */
+const AudioSource = (engine) => (0, AudioSource_1.defineAudioSourceComponent)(engine);
+exports.AudioSource = AudioSource;
+/* @__PURE__ */
 const MeshRenderer = (engine) => (0, MeshRenderer_1.defineMeshRendererComponent)(engine);
 exports.MeshRenderer = MeshRenderer;
 /* @__PURE__ */

package/dist-cjs/components/types.d.ts

@@ -1,4 +1,5 @@
 export type { AnimatorComponentDefinitionExtended } from './extended/Animator';
+export type { AudioSourceComponentDefinitionExtended } from './extended/AudioSource';
 export type { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
 export type { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
 export type { TextureHelper, MaterialComponentDefinitionExtended } from './extended/Material';

package/dist-cjs/composite/proto/gen/composite.gen.js

@@ -90,7 +90,7 @@ var CompositeComponent;
         if (message.jsonSchema !== undefined) {
             struct_gen_1.Value.encode(struct_gen_1.Value.wrap(message.jsonSchema), writer.uint32(18).fork()).ldelim();
         }
-        (message.data).forEach((value, key) => {
+        message.data.forEach((value, key) => {
             CompositeComponent_DataEntry.encode({ key: key, value }, writer.uint32(26).fork()).ldelim();
         });
         return writer;

package/dist-cjs/composite/proto/gen/google/protobuf/struct.gen.js

@@ -55,7 +55,7 @@ function createBaseStruct() {
 var Struct;
 (function (Struct) {
     function encode(message, writer = minimal_1.default.Writer.create()) {
-        (message.fields).forEach((value, key) => {
+        message.fields.forEach((value, key) => {
             if (value !== undefined) {
                 Struct_FieldsEntry.encode({ key: key, value }, writer.uint32(10).fork()).ldelim();
             }

package/dist-cjs/index.d.ts

@@ -11,10 +11,11 @@ export * from './systems/async-task';
 export * from './systems/tween';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent } from './components/types';
 import { NameComponent } from './components/manual/Name';
 export declare const Transform: TransformComponentExtended;
 export declare const Animator: AnimatorComponentDefinitionExtended;
+export declare const AudioSource: AudioSourceComponentDefinitionExtended;
 export declare const Material: MaterialComponentDefinitionExtended;
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;

package/dist-cjs/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Tween = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
+exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Tween = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
 // The order of the following imports matters. Please do not auto-sort
 __exportStar(require("./engine"), exports);
 __exportStar(require("./schemas"), exports);
@@ -49,6 +49,7 @@ const initialization_1 = require("./runtime/initialization");
 // export components for global engine
 exports.Transform = components.Transform(initialization_1.engine);
 exports.Animator = components.Animator(initialization_1.engine);
+exports.AudioSource = components.AudioSource(initialization_1.engine);
 exports.Material = components.Material(initialization_1.engine);
 exports.MeshRenderer = components.MeshRenderer(initialization_1.engine);
 exports.MeshCollider = components.MeshCollider(initialization_1.engine);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.4.10-8392909116.commit-6487246",
+  "version": "7.4.10-8394982680.commit-841a9e7",
   "author": "DCL",
   "bugs": "https://github.com/decentraland/ecs/issues",
   "files": [
@@ -33,5 +33,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "64872460277fc8eeaacd25ac366eb9e22195dec5"
+  "commit": "841a9e70897121a4e420f983c632544bb7ff7f12"
 }