@dcl/playground-assets 7.10.2 → 7.10.3-18106625709.commit-1bcaa4a

package/dist/alpha.d.ts

@@ -541,7 +541,8 @@ export declare const enum ColliderLayer {
     CL_POINTER = 1,
     /** CL_PHYSICS - collision affecting your player's physics i.e. walls, floor, moving platfroms */
     CL_PHYSICS = 2,
-    CL_RESERVED1 = 4,
+    /** CL_PLAYER - layer corresponding to any player avatar */
+    CL_PLAYER = 4,
     CL_RESERVED2 = 8,
     CL_RESERVED3 = 16,
     CL_RESERVED4 = 32,
@@ -1326,6 +1327,8 @@ export declare const componentDefinitionByName: {
     "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
     "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
+    "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
+    "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
     "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
     "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
     "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
@@ -2250,6 +2253,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
@@ -5453,6 +5463,86 @@ export declare namespace PBTextShape {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
 }
 
+/**
+ * The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
+ * when entities enter this component's defined area.
+ *
+ * ADR: https://github.com/decentraland/adr/blob/2b30a5e2b4f359a7c22a68fb827db282f6e5f887/content/ADR-258-trigger-areas.md
+ *
+ * The area size and rotation is defined by the Entity's Transform.
+ */
+/**
+ * @public
+ */
+export declare interface PBTriggerArea {
+    /** default: MT_BOX */
+    mesh?: TriggerAreaMeshType | undefined;
+    /** default: CL_PLAYER */
+    collisionMask?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTriggerArea {
+    export function encode(message: PBTriggerArea, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTriggerArea;
+}
+
+/**
+ * The PBTriggerAreaResult component is used to transport the trigger collision event data for the PBTriggerArea component.
+ * ADR: https://github.com/decentraland/adr/blob/2b30a5e2b4f359a7c22a68fb827db282f6e5f887/content/ADR-258-trigger-areas.md
+ */
+/**
+ * @public
+ */
+export declare interface PBTriggerAreaResult {
+    /** The entity that was triggered (this is the entity that owns the trigger area) */
+    triggeredEntity: number;
+    /** The position of the triggered entity at the time of the trigger */
+    triggeredEntityPosition: PBVector3 | undefined;
+    /** The rotation of the triggered entity at the time of the trigger */
+    triggeredEntityRotation: PBQuaternion | undefined;
+    /** The state of the trigger event (ENTER, STAY, EXIT) */
+    eventType: TriggerAreaEventType;
+    /** The timestamp of the trigger event */
+    timestamp: number;
+    trigger: PBTriggerAreaResult_Trigger | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTriggerAreaResult {
+    export function encode(message: PBTriggerAreaResult, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTriggerAreaResult;
+}
+
+/** Trigger data object */
+/**
+ * @public
+ */
+export declare interface PBTriggerAreaResult_Trigger {
+    /** The entity that triggered the Trigger Area */
+    entity: number;
+    /** The collision layermask of the entity that triggered the Trigger Area */
+    layers: number;
+    /** The position of the entity that triggered the trigger */
+    position: PBVector3 | undefined;
+    /** The rotation of the entity that triggered the trigger */
+    rotation: PBQuaternion | undefined;
+    /** The scale of the entity that triggered the trigger */
+    scale: PBVector3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTriggerAreaResult_Trigger {
+    export function encode(message: PBTriggerAreaResult_Trigger, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTriggerAreaResult_Trigger;
+}
+
 /**
  * @public
  */
@@ -7277,6 +7367,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 = {
@@ -7546,6 +7663,104 @@ export declare type Transport = {
  */
 export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
 
+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
+ */
+export declare const enum TriggerAreaEventType {
+    TAET_ENTER = 0,
+    TAET_STAY = 1,
+    TAET_EXIT = 2
+}
+
+/**
+ * @public
+ */
+export declare const enum TriggerAreaMeshType {
+    TAMT_BOX = 0,
+    TAMT_SPHERE = 1
+}
+
+/** @public */
+export declare const TriggerAreaResult: GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>;
+
 export declare const Tween: TweenComponentDefinitionExtended;
 
 /**

package/dist/beta.d.ts

@@ -541,7 +541,8 @@ export declare const enum ColliderLayer {
     CL_POINTER = 1,
     /** CL_PHYSICS - collision affecting your player's physics i.e. walls, floor, moving platfroms */
     CL_PHYSICS = 2,
-    CL_RESERVED1 = 4,
+    /** CL_PLAYER - layer corresponding to any player avatar */
+    CL_PLAYER = 4,
     CL_RESERVED2 = 8,
     CL_RESERVED3 = 16,
     CL_RESERVED4 = 32,
@@ -1326,6 +1327,8 @@ export declare const componentDefinitionByName: {
     "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
     "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
+    "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
+    "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
     "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
     "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
     "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
@@ -2245,6 +2248,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
@@ -5425,6 +5435,86 @@ export declare namespace PBTextShape {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
 }
 
+/**
+ * The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
+ * when entities enter this component's defined area.
+ *
+ * ADR: https://github.com/decentraland/adr/blob/2b30a5e2b4f359a7c22a68fb827db282f6e5f887/content/ADR-258-trigger-areas.md
+ *
+ * The area size and rotation is defined by the Entity's Transform.
+ */
+/**
+ * @public
+ */
+export declare interface PBTriggerArea {
+    /** default: MT_BOX */
+    mesh?: TriggerAreaMeshType | undefined;
+    /** default: CL_PLAYER */
+    collisionMask?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTriggerArea {
+    export function encode(message: PBTriggerArea, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTriggerArea;
+}
+
+/**
+ * The PBTriggerAreaResult component is used to transport the trigger collision event data for the PBTriggerArea component.
+ * ADR: https://github.com/decentraland/adr/blob/2b30a5e2b4f359a7c22a68fb827db282f6e5f887/content/ADR-258-trigger-areas.md
+ */
+/**
+ * @public
+ */
+export declare interface PBTriggerAreaResult {
+    /** The entity that was triggered (this is the entity that owns the trigger area) */
+    triggeredEntity: number;
+    /** The position of the triggered entity at the time of the trigger */
+    triggeredEntityPosition: PBVector3 | undefined;
+    /** The rotation of the triggered entity at the time of the trigger */
+    triggeredEntityRotation: PBQuaternion | undefined;
+    /** The state of the trigger event (ENTER, STAY, EXIT) */
+    eventType: TriggerAreaEventType;
+    /** The timestamp of the trigger event */
+    timestamp: number;
+    trigger: PBTriggerAreaResult_Trigger | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTriggerAreaResult {
+    export function encode(message: PBTriggerAreaResult, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTriggerAreaResult;
+}
+
+/** Trigger data object */
+/**
+ * @public
+ */
+export declare interface PBTriggerAreaResult_Trigger {
+    /** The entity that triggered the Trigger Area */
+    entity: number;
+    /** The collision layermask of the entity that triggered the Trigger Area */
+    layers: number;
+    /** The position of the entity that triggered the trigger */
+    position: PBVector3 | undefined;
+    /** The rotation of the entity that triggered the trigger */
+    rotation: PBQuaternion | undefined;
+    /** The scale of the entity that triggered the trigger */
+    scale: PBVector3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTriggerAreaResult_Trigger {
+    export function encode(message: PBTriggerAreaResult_Trigger, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTriggerAreaResult_Trigger;
+}
+
 /**
  * @public
  */
@@ -7244,6 +7334,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 = {
@@ -7513,6 +7630,104 @@ export declare type Transport = {
  */
 export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
 
+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
+ */
+export declare const enum TriggerAreaEventType {
+    TAET_ENTER = 0,
+    TAET_STAY = 1,
+    TAET_EXIT = 2
+}
+
+/**
+ * @public
+ */
+export declare const enum TriggerAreaMeshType {
+    TAMT_BOX = 0,
+    TAMT_SPHERE = 1
+}
+
+/** @public */
+export declare const TriggerAreaResult: GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>;
+
 export declare const Tween: TweenComponentDefinitionExtended;
 
 /**