@dcl/playground-assets 7.22.1 → 7.22.2-23600507492.commit-5f7f8a0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/alpha.d.ts +80 -1
- package/dist/beta.d.ts +80 -1
- package/dist/index.bundled.d.ts +80 -1
- package/dist/index.js +7 -7
- package/dist/index.js.map +3 -3
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground/snippets/pointer-events.ts +14 -7
- package/dist/playground-assets.d.ts +80 -1
- package/etc/playground-assets.api.json +735 -35
- package/etc/playground-assets.api.md +35 -0
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -2034,6 +2034,7 @@ export declare type EventSystemOptions = {
|
|
|
2034
2034
|
showFeedback?: boolean;
|
|
2035
2035
|
showHighlight?: boolean;
|
|
2036
2036
|
maxPlayerDistance?: number;
|
|
2037
|
+
priority?: number;
|
|
2037
2038
|
};
|
|
2038
2039
|
|
|
2039
2040
|
/**
|
|
@@ -2744,6 +2745,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2744
2745
|
alreadyRequestedSrc?: Set<string>;
|
|
2745
2746
|
};
|
|
2746
2747
|
|
|
2748
|
+
/**
|
|
2749
|
+
* @public
|
|
2750
|
+
*/
|
|
2751
|
+
export declare const enum InteractionType {
|
|
2752
|
+
CURSOR = 0,
|
|
2753
|
+
PROXIMITY = 1
|
|
2754
|
+
}
|
|
2755
|
+
|
|
2747
2756
|
/**
|
|
2748
2757
|
* @public
|
|
2749
2758
|
*/
|
|
@@ -5552,6 +5561,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5552
5561
|
eventType: PointerEventType;
|
|
5553
5562
|
/** additional configuration for this detection */
|
|
5554
5563
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5564
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5565
|
+
interactionType?: InteractionType | undefined;
|
|
5555
5566
|
}
|
|
5556
5567
|
|
|
5557
5568
|
/**
|
|
@@ -5578,6 +5589,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5578
5589
|
showHighlight?: boolean | undefined;
|
|
5579
5590
|
/** range of interaction from the avatar's position (default 0) */
|
|
5580
5591
|
maxPlayerDistance?: number | undefined;
|
|
5592
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5593
|
+
priority?: number | undefined;
|
|
5581
5594
|
}
|
|
5582
5595
|
|
|
5583
5596
|
/**
|
|
@@ -6736,6 +6749,30 @@ export declare interface PointerEventsSystem {
|
|
|
6736
6749
|
* @param entity - Entity where the callback was attached
|
|
6737
6750
|
*/
|
|
6738
6751
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6752
|
+
/**
|
|
6753
|
+
* @public
|
|
6754
|
+
* Remove the callback for onProximityDown event
|
|
6755
|
+
* @param entity - Entity where the callback was attached
|
|
6756
|
+
*/
|
|
6757
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6758
|
+
/**
|
|
6759
|
+
* @public
|
|
6760
|
+
* Remove the callback for onProximityUp event
|
|
6761
|
+
* @param entity - Entity where the callback was attached
|
|
6762
|
+
*/
|
|
6763
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6764
|
+
/**
|
|
6765
|
+
* @public
|
|
6766
|
+
* Remove the callback for onProximityEnter event
|
|
6767
|
+
* @param entity - Entity where the callback was attached
|
|
6768
|
+
*/
|
|
6769
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6770
|
+
/**
|
|
6771
|
+
* @public
|
|
6772
|
+
* Remove the callback for onProximityLeave event
|
|
6773
|
+
* @param entity - Entity where the callback was attached
|
|
6774
|
+
*/
|
|
6775
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6739
6776
|
/**
|
|
6740
6777
|
* @public
|
|
6741
6778
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6790,6 +6827,46 @@ export declare interface PointerEventsSystem {
|
|
|
6790
6827
|
entity: Entity;
|
|
6791
6828
|
opts?: Partial<EventSystemOptions>;
|
|
6792
6829
|
}, cb: EventSystemCallback): void;
|
|
6830
|
+
/**
|
|
6831
|
+
* @public
|
|
6832
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6833
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6834
|
+
* @param cb - Function to execute when click fires
|
|
6835
|
+
*/
|
|
6836
|
+
onProximityDown(pointerData: {
|
|
6837
|
+
entity: Entity;
|
|
6838
|
+
opts?: Partial<EventSystemOptions>;
|
|
6839
|
+
}, cb: EventSystemCallback): void;
|
|
6840
|
+
/**
|
|
6841
|
+
* @public
|
|
6842
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6843
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6844
|
+
* @param cb - Function to execute when event fires
|
|
6845
|
+
*/
|
|
6846
|
+
onProximityUp(pointerData: {
|
|
6847
|
+
entity: Entity;
|
|
6848
|
+
opts?: Partial<EventSystemOptions>;
|
|
6849
|
+
}, cb: EventSystemCallback): void;
|
|
6850
|
+
/**
|
|
6851
|
+
* @public
|
|
6852
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6853
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6854
|
+
* @param cb - Function to execute when event fires
|
|
6855
|
+
*/
|
|
6856
|
+
onProximityEnter(pointerData: {
|
|
6857
|
+
entity: Entity;
|
|
6858
|
+
opts?: Partial<EventSystemOptions>;
|
|
6859
|
+
}, cb: EventSystemCallback): void;
|
|
6860
|
+
/**
|
|
6861
|
+
* @public
|
|
6862
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6863
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6864
|
+
* @param cb - Function to execute when event fires
|
|
6865
|
+
*/
|
|
6866
|
+
onProximityLeave(pointerData: {
|
|
6867
|
+
entity: Entity;
|
|
6868
|
+
opts?: Partial<EventSystemOptions>;
|
|
6869
|
+
}, cb: EventSystemCallback): void;
|
|
6793
6870
|
}
|
|
6794
6871
|
|
|
6795
6872
|
/**
|
|
@@ -6806,7 +6883,9 @@ export declare const enum PointerEventType {
|
|
|
6806
6883
|
PET_UP = 0,
|
|
6807
6884
|
PET_DOWN = 1,
|
|
6808
6885
|
PET_HOVER_ENTER = 2,
|
|
6809
|
-
PET_HOVER_LEAVE = 3
|
|
6886
|
+
PET_HOVER_LEAVE = 3,
|
|
6887
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6888
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6810
6889
|
}
|
|
6811
6890
|
|
|
6812
6891
|
/**
|
package/dist/beta.d.ts
CHANGED
|
@@ -2034,6 +2034,7 @@ export declare type EventSystemOptions = {
|
|
|
2034
2034
|
showFeedback?: boolean;
|
|
2035
2035
|
showHighlight?: boolean;
|
|
2036
2036
|
maxPlayerDistance?: number;
|
|
2037
|
+
priority?: number;
|
|
2037
2038
|
};
|
|
2038
2039
|
|
|
2039
2040
|
/**
|
|
@@ -2735,6 +2736,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2735
2736
|
alreadyRequestedSrc?: Set<string>;
|
|
2736
2737
|
};
|
|
2737
2738
|
|
|
2739
|
+
/**
|
|
2740
|
+
* @public
|
|
2741
|
+
*/
|
|
2742
|
+
export declare const enum InteractionType {
|
|
2743
|
+
CURSOR = 0,
|
|
2744
|
+
PROXIMITY = 1
|
|
2745
|
+
}
|
|
2746
|
+
|
|
2738
2747
|
/**
|
|
2739
2748
|
* @public
|
|
2740
2749
|
*/
|
|
@@ -5524,6 +5533,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5524
5533
|
eventType: PointerEventType;
|
|
5525
5534
|
/** additional configuration for this detection */
|
|
5526
5535
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5536
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5537
|
+
interactionType?: InteractionType | undefined;
|
|
5527
5538
|
}
|
|
5528
5539
|
|
|
5529
5540
|
/**
|
|
@@ -5550,6 +5561,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5550
5561
|
showHighlight?: boolean | undefined;
|
|
5551
5562
|
/** range of interaction from the avatar's position (default 0) */
|
|
5552
5563
|
maxPlayerDistance?: number | undefined;
|
|
5564
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5565
|
+
priority?: number | undefined;
|
|
5553
5566
|
}
|
|
5554
5567
|
|
|
5555
5568
|
/**
|
|
@@ -6708,6 +6721,30 @@ export declare interface PointerEventsSystem {
|
|
|
6708
6721
|
* @param entity - Entity where the callback was attached
|
|
6709
6722
|
*/
|
|
6710
6723
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6724
|
+
/**
|
|
6725
|
+
* @public
|
|
6726
|
+
* Remove the callback for onProximityDown event
|
|
6727
|
+
* @param entity - Entity where the callback was attached
|
|
6728
|
+
*/
|
|
6729
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6730
|
+
/**
|
|
6731
|
+
* @public
|
|
6732
|
+
* Remove the callback for onProximityUp event
|
|
6733
|
+
* @param entity - Entity where the callback was attached
|
|
6734
|
+
*/
|
|
6735
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6736
|
+
/**
|
|
6737
|
+
* @public
|
|
6738
|
+
* Remove the callback for onProximityEnter event
|
|
6739
|
+
* @param entity - Entity where the callback was attached
|
|
6740
|
+
*/
|
|
6741
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6742
|
+
/**
|
|
6743
|
+
* @public
|
|
6744
|
+
* Remove the callback for onProximityLeave event
|
|
6745
|
+
* @param entity - Entity where the callback was attached
|
|
6746
|
+
*/
|
|
6747
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6711
6748
|
/**
|
|
6712
6749
|
* @public
|
|
6713
6750
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6762,6 +6799,46 @@ export declare interface PointerEventsSystem {
|
|
|
6762
6799
|
entity: Entity;
|
|
6763
6800
|
opts?: Partial<EventSystemOptions>;
|
|
6764
6801
|
}, cb: EventSystemCallback): void;
|
|
6802
|
+
/**
|
|
6803
|
+
* @public
|
|
6804
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6805
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6806
|
+
* @param cb - Function to execute when click fires
|
|
6807
|
+
*/
|
|
6808
|
+
onProximityDown(pointerData: {
|
|
6809
|
+
entity: Entity;
|
|
6810
|
+
opts?: Partial<EventSystemOptions>;
|
|
6811
|
+
}, cb: EventSystemCallback): void;
|
|
6812
|
+
/**
|
|
6813
|
+
* @public
|
|
6814
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6815
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6816
|
+
* @param cb - Function to execute when event fires
|
|
6817
|
+
*/
|
|
6818
|
+
onProximityUp(pointerData: {
|
|
6819
|
+
entity: Entity;
|
|
6820
|
+
opts?: Partial<EventSystemOptions>;
|
|
6821
|
+
}, cb: EventSystemCallback): void;
|
|
6822
|
+
/**
|
|
6823
|
+
* @public
|
|
6824
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6825
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6826
|
+
* @param cb - Function to execute when event fires
|
|
6827
|
+
*/
|
|
6828
|
+
onProximityEnter(pointerData: {
|
|
6829
|
+
entity: Entity;
|
|
6830
|
+
opts?: Partial<EventSystemOptions>;
|
|
6831
|
+
}, cb: EventSystemCallback): void;
|
|
6832
|
+
/**
|
|
6833
|
+
* @public
|
|
6834
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6835
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6836
|
+
* @param cb - Function to execute when event fires
|
|
6837
|
+
*/
|
|
6838
|
+
onProximityLeave(pointerData: {
|
|
6839
|
+
entity: Entity;
|
|
6840
|
+
opts?: Partial<EventSystemOptions>;
|
|
6841
|
+
}, cb: EventSystemCallback): void;
|
|
6765
6842
|
}
|
|
6766
6843
|
|
|
6767
6844
|
/**
|
|
@@ -6778,7 +6855,9 @@ export declare const enum PointerEventType {
|
|
|
6778
6855
|
PET_UP = 0,
|
|
6779
6856
|
PET_DOWN = 1,
|
|
6780
6857
|
PET_HOVER_ENTER = 2,
|
|
6781
|
-
PET_HOVER_LEAVE = 3
|
|
6858
|
+
PET_HOVER_LEAVE = 3,
|
|
6859
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6860
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6782
6861
|
}
|
|
6783
6862
|
|
|
6784
6863
|
/**
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -2034,6 +2034,7 @@ export declare type EventSystemOptions = {
|
|
|
2034
2034
|
showFeedback?: boolean;
|
|
2035
2035
|
showHighlight?: boolean;
|
|
2036
2036
|
maxPlayerDistance?: number;
|
|
2037
|
+
priority?: number;
|
|
2037
2038
|
};
|
|
2038
2039
|
|
|
2039
2040
|
/**
|
|
@@ -2735,6 +2736,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2735
2736
|
alreadyRequestedSrc?: Set<string>;
|
|
2736
2737
|
};
|
|
2737
2738
|
|
|
2739
|
+
/**
|
|
2740
|
+
* @public
|
|
2741
|
+
*/
|
|
2742
|
+
export declare const enum InteractionType {
|
|
2743
|
+
CURSOR = 0,
|
|
2744
|
+
PROXIMITY = 1
|
|
2745
|
+
}
|
|
2746
|
+
|
|
2738
2747
|
/**
|
|
2739
2748
|
* @public
|
|
2740
2749
|
*/
|
|
@@ -5524,6 +5533,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5524
5533
|
eventType: PointerEventType;
|
|
5525
5534
|
/** additional configuration for this detection */
|
|
5526
5535
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5536
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5537
|
+
interactionType?: InteractionType | undefined;
|
|
5527
5538
|
}
|
|
5528
5539
|
|
|
5529
5540
|
/**
|
|
@@ -5550,6 +5561,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5550
5561
|
showHighlight?: boolean | undefined;
|
|
5551
5562
|
/** range of interaction from the avatar's position (default 0) */
|
|
5552
5563
|
maxPlayerDistance?: number | undefined;
|
|
5564
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5565
|
+
priority?: number | undefined;
|
|
5553
5566
|
}
|
|
5554
5567
|
|
|
5555
5568
|
/**
|
|
@@ -6708,6 +6721,30 @@ export declare interface PointerEventsSystem {
|
|
|
6708
6721
|
* @param entity - Entity where the callback was attached
|
|
6709
6722
|
*/
|
|
6710
6723
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6724
|
+
/**
|
|
6725
|
+
* @public
|
|
6726
|
+
* Remove the callback for onProximityDown event
|
|
6727
|
+
* @param entity - Entity where the callback was attached
|
|
6728
|
+
*/
|
|
6729
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6730
|
+
/**
|
|
6731
|
+
* @public
|
|
6732
|
+
* Remove the callback for onProximityUp event
|
|
6733
|
+
* @param entity - Entity where the callback was attached
|
|
6734
|
+
*/
|
|
6735
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6736
|
+
/**
|
|
6737
|
+
* @public
|
|
6738
|
+
* Remove the callback for onProximityEnter event
|
|
6739
|
+
* @param entity - Entity where the callback was attached
|
|
6740
|
+
*/
|
|
6741
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6742
|
+
/**
|
|
6743
|
+
* @public
|
|
6744
|
+
* Remove the callback for onProximityLeave event
|
|
6745
|
+
* @param entity - Entity where the callback was attached
|
|
6746
|
+
*/
|
|
6747
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6711
6748
|
/**
|
|
6712
6749
|
* @public
|
|
6713
6750
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6762,6 +6799,46 @@ export declare interface PointerEventsSystem {
|
|
|
6762
6799
|
entity: Entity;
|
|
6763
6800
|
opts?: Partial<EventSystemOptions>;
|
|
6764
6801
|
}, cb: EventSystemCallback): void;
|
|
6802
|
+
/**
|
|
6803
|
+
* @public
|
|
6804
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6805
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6806
|
+
* @param cb - Function to execute when click fires
|
|
6807
|
+
*/
|
|
6808
|
+
onProximityDown(pointerData: {
|
|
6809
|
+
entity: Entity;
|
|
6810
|
+
opts?: Partial<EventSystemOptions>;
|
|
6811
|
+
}, cb: EventSystemCallback): void;
|
|
6812
|
+
/**
|
|
6813
|
+
* @public
|
|
6814
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6815
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6816
|
+
* @param cb - Function to execute when event fires
|
|
6817
|
+
*/
|
|
6818
|
+
onProximityUp(pointerData: {
|
|
6819
|
+
entity: Entity;
|
|
6820
|
+
opts?: Partial<EventSystemOptions>;
|
|
6821
|
+
}, cb: EventSystemCallback): void;
|
|
6822
|
+
/**
|
|
6823
|
+
* @public
|
|
6824
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6825
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6826
|
+
* @param cb - Function to execute when event fires
|
|
6827
|
+
*/
|
|
6828
|
+
onProximityEnter(pointerData: {
|
|
6829
|
+
entity: Entity;
|
|
6830
|
+
opts?: Partial<EventSystemOptions>;
|
|
6831
|
+
}, cb: EventSystemCallback): void;
|
|
6832
|
+
/**
|
|
6833
|
+
* @public
|
|
6834
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6835
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6836
|
+
* @param cb - Function to execute when event fires
|
|
6837
|
+
*/
|
|
6838
|
+
onProximityLeave(pointerData: {
|
|
6839
|
+
entity: Entity;
|
|
6840
|
+
opts?: Partial<EventSystemOptions>;
|
|
6841
|
+
}, cb: EventSystemCallback): void;
|
|
6765
6842
|
}
|
|
6766
6843
|
|
|
6767
6844
|
/**
|
|
@@ -6778,7 +6855,9 @@ export declare const enum PointerEventType {
|
|
|
6778
6855
|
PET_UP = 0,
|
|
6779
6856
|
PET_DOWN = 1,
|
|
6780
6857
|
PET_HOVER_ENTER = 2,
|
|
6781
|
-
PET_HOVER_LEAVE = 3
|
|
6858
|
+
PET_HOVER_LEAVE = 3,
|
|
6859
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6860
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6782
6861
|
}
|
|
6783
6862
|
|
|
6784
6863
|
/**
|