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

package/dist/alpha.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/beta.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.
@@ -4098,6 +4129,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
@@ -4113,6 +4151,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/index.bundled.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.
@@ -4098,6 +4129,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
@@ -4113,6 +4151,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;
 }
 
 /**