@dcl/playground-assets 7.12.3-19251638766.commit-26dce86 → 7.12.3-19269915433.commit-cbf59ef

package/dist/index.bundled.d.ts

@@ -193,7 +193,8 @@ export declare const enum AvatarControlType {
 /** @public */
 export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
 
-export declare const AvatarEquippedData: AvatarEquippedDataComponentDefinitionExtended;
+/** @public */
+export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
 
 /**
  * @public
@@ -249,7 +250,8 @@ export declare namespace AvatarMovementSettings {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
 }
 
-export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
+/** @public */
+export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
 
 /**
  * @public
@@ -1434,7 +1436,7 @@ export declare const componentDefinitionByName: {
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
     "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
     "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
-    "core::TriggerAreaResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerAreaResult>>;
+    "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
     "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
     "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
     "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
@@ -2389,6 +2391,13 @@ export declare interface IEngine {
      * @typeParam T - The type of the entity name value
      */
     getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
+    /**
+     * @public
+     * Get all entities that have a specific tag in their Tag component
+     * @param tag - Tag to search
+     * @returns Iterator of entities that have the given tag
+     */
+    getEntitiesByTag(tagName: string): Iterable<Entity>;
     /**
      * @public
      * @param deltaTime - deltaTime in seconds
@@ -2822,8 +2831,31 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
     getOrCreateMutable(entity: Entity, initialValue?: T): T;
 }
 
-/** @public */
-export declare const LightSource: LastWriteWinElementSetComponentDefinition<PBLightSource>;
+export declare const LightSource: LightSourceComponentDefinitionExtended;
+
+/**
+ * @public
+ */
+export declare interface LightSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBLightSource> {
+    /**
+     * LightSource helper with constructor
+     */
+    Type: LightSourceHelper;
+}
+
+/**
+ * @public
+ */
+export declare interface LightSourceHelper {
+    /**
+     * @returns a Light Source type
+     */
+    Point: (point: PBLightSource_Point) => PBLightSource['type'];
+    /**
+     * @returns a Light Source type
+     */
+    Spot: (spot: PBLightSource_Spot) => PBLightSource['type'];
+}
 
 /**
  * User key event Listeners
@@ -8045,6 +8077,33 @@ export declare type SystemItem = {
 
 export declare const SYSTEMS_REGULAR_PRIORITY = 100000;
 
+export declare const Tags: TagsComponentDefinitionExtended;
+
+export declare interface TagsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<TagsType> {
+    /**
+     * @public
+     *
+     * Add a tag to the entity's Tags component or create the component if it doesn't exist and add the tag
+     * @param entity - entity to add the tag to
+     * @param tagName - the tag name to add
+     * @returns true
+     */
+    add(entity: Entity, tagName: string): boolean;
+    /**
+     * @public
+     *
+     * Remove a tag from the entity's Tags component
+     * @param entity - entity to remove the tag from
+     * @param tagName - the tag name to remove
+     * @returns true if successful, false if the entity doesn't have a Tags component or the tag doesn't exist
+     */
+    remove(entity: Entity, tagName: string): boolean;
+}
+
+export declare interface TagsType {
+    tags: string[];
+}
+
 export declare type TargetEntityRaycastOptions = RaycastSystemOptions & TargetEntityRaycastSystemOptions;
 
 export declare type TargetEntityRaycastSystemOptions = {
@@ -8338,8 +8397,83 @@ export declare type Transport = {
  */
 export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
 
-/** @public */
-export declare const TriggerArea: LastWriteWinElementSetComponentDefinition<PBTriggerArea>;
+export declare const TriggerArea: TriggerAreaComponentDefinitionExtended;
+
+/**
+ * @public
+ */
+export declare interface TriggerAreaComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTriggerArea> {
+    /**
+     * @public
+     * Set a box in the MeshCollider component
+     * @param entity - entity to create or replace the TriggerArea component
+     * @param collisionMask - the collision layers mask for the trigger to react, default: Player
+     */
+    setBox(entity: Entity, collisionMask?: ColliderLayer | ColliderLayer[]): void;
+    /**
+     * @public
+     * Set a sphere in the MeshCollider component
+     * @param entity - entity to create or replace the TriggerArea component
+     * @param collisionMask - the collision layers mask for the trigger to react, default: Player
+     */
+    setSphere(entity: Entity, collisionMask?: ColliderLayer | ColliderLayer[]): void;
+}
+
+/**
+ * @public
+ */
+export declare interface TriggerAreaEventsSystem {
+    /**
+     * @public
+     * Execute callback when an entity enters the Trigger Area
+     * @param entity - The entity that already has the TriggerArea component
+     * @param cb - Function to execute the 'Enter' type of result is detected
+     */
+    onTriggerEnter(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
+    /**
+     * @public
+     * Remove the callback for Trigger Area 'Enter' type of result
+     * @param entity - Entity where the Trigger Area was attached
+     */
+    removeOnTriggerEnter(entity: Entity): void;
+    /**
+     * @public
+     * Execute callback when an entity stays in the Trigger Area
+     * @param entity - The entity that already has the TriggerArea component
+     * @param cb - Function to execute the 'Stay' type of result is detected
+     */
+    onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
+    /**
+     * @public
+     * Remove the callback for Trigger Area 'Stay' type of result
+     * @param entity - Entity where the Trigger Area was attached
+     */
+    removeOnTriggerStay(entity: Entity): void;
+    /**
+     * @public
+     * Execute callback when an entity exits the Trigger Area
+     * @param entity - The entity that already has the TriggerArea component
+     * @param cb - Function to execute the 'Exit' type of result is detected
+     */
+    onTriggerExit(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
+    /**
+     * @public
+     * Remove the callback for Trigger Area 'Exit' type of result
+     * @param entity - Entity where the Trigger Area was attached
+     */
+    removeOnTriggerExit(entity: Entity): void;
+}
+
+/**
+ * @public
+ * Register callback functions for trigger area results.
+ */
+export declare const triggerAreaEventsSystem: TriggerAreaEventsSystem;
+
+/**
+ * @public
+ */
+export declare type TriggerAreaEventSystemCallback = (result: DeepReadonlyObject<PBTriggerAreaResult>) => void;
 
 /**
  * @public
@@ -8359,7 +8493,7 @@ export declare const enum TriggerAreaMeshType {
 }
 
 /** @public */
-export declare const TriggerAreaResult: LastWriteWinElementSetComponentDefinition<PBTriggerAreaResult>;
+export declare const TriggerAreaResult: GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>;
 
 export declare const Tween: TweenComponentDefinitionExtended;
 
@@ -8371,6 +8505,82 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
      * Texture helpers with constructor
      */
     Mode: TweenHelper;
+    /**
+     * @public
+     *
+     * Creates or replaces a move tween component that animates an entity's position from start to end
+     * @param entity - entity to apply the tween to
+     * @param start - starting position vector
+     * @param end - ending position vector
+     * @param duration - duration of the tween in milliseconds
+     * @param easingFunction - easing function to use (defaults to EF_LINEAR)
+     */
+    setMove(entity: Entity, start: PBVector3, end: PBVector3, duration: number, easingFunction?: EasingFunction): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a scale tween component that animates an entity's scale from start to end
+     * @param entity - entity to apply the tween to
+     * @param start - starting scale vector
+     * @param end - ending scale vector
+     * @param duration - duration of the tween in milliseconds
+     * @param easingFunction - easing function to use (defaults to EF_LINEAR)
+     */
+    setScale(entity: Entity, start: PBVector3, end: PBVector3, duration: number, easingFunction?: EasingFunction): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a rotation tween component that animates an entity's rotation from start to end
+     * @param entity - entity to apply the tween to
+     * @param start - starting rotation quaternion
+     * @param end - ending rotation quaternion
+     * @param duration - duration of the tween in milliseconds
+     * @param easingFunction - easing function to use (defaults to EF_LINEAR)
+     */
+    setRotate(entity: Entity, start: PBQuaternion, end: PBQuaternion, duration: number, easingFunction?: EasingFunction): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a texture move tween component that animates texture UV coordinates from start to end
+     * @param entity - entity to apply the tween to
+     * @param start - starting UV coordinates
+     * @param end - ending UV coordinates
+     * @param duration - duration of the tween in milliseconds
+     * @param movementType - type of texture movement (defaults to TMT_OFFSET)
+     * @param easingFunction - easing function to use (defaults to EF_LINEAR)
+     */
+    setTextureMove(entity: Entity, start: PBVector2, end: PBVector2, duration: number, movementType?: TextureMovementType, easingFunction?: EasingFunction): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a continuous move tween component that moves an entity continuously in a direction
+     * @param entity - entity to apply the tween to
+     * @param direction - direction vector to move towards
+     * @param speed - speed of movement per second
+     * @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
+     */
+    setMoveContinuous(entity: Entity, direction: PBVector3, speed: number, duration?: number): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a continuous rotation tween component that rotates an entity continuously
+     * @param entity - entity to apply the tween to
+     * @param direction - rotation direction quaternion
+     * @param speed - speed of rotation per second
+     * @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
+     */
+    setRotateContinuous(entity: Entity, direction: PBQuaternion, speed: number, duration?: number): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a continuous texture move tween component that moves texture UV coordinates continuously
+     * @param entity - entity to apply the tween to
+     * @param direction - direction vector for UV movement
+     * @param speed - speed of UV movement per second
+     * @param movementType - type of texture movement (defaults to TMT_OFFSET)
+     * @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
+     */
+    setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
 }
 
 /**
@@ -8382,17 +8592,29 @@ export declare interface TweenHelper {
      */
     Move: (move: Move) => PBTween['mode'];
     /**
-     * @returns a move mode tween
+     * @returns a move-continuous mode tween
+     */
+    MoveContinuous: (move: MoveContinuous) => PBTween['mode'];
+    /**
+     * @returns a rotate mode tween
      */
     Rotate: (rotate: Rotate) => PBTween['mode'];
     /**
-     * @returns a move mode tween
+     * @returns a rotate-continuous mode tween
+     */
+    RotateContinuous: (rotate: RotateContinuous) => PBTween['mode'];
+    /**
+     * @returns a scale mode tween
      */
     Scale: (scale: Scale) => PBTween['mode'];
     /**
-     * @returns a texture move mode tween
+     * @returns a texture-move mode tween
      */
     TextureMove: (textureMove: TextureMove) => PBTween['mode'];
+    /**
+     * @returns a texture-move-continuous mode tween
+     */
+    TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
 }
 
 /**