@dcl/playground-assets 7.20.5-22674879735.commit-6a30e67 → 7.20.5-22869988861.commit-9d0cc3a
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 +17 -220
- package/dist/beta.d.ts +17 -220
- package/dist/index.bundled.d.ts +17 -220
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground/snippets/pointer-events.ts +7 -14
- package/dist/playground-assets.d.ts +17 -220
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +207 -2290
- package/etc/playground-assets.api.md +6 -129
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -115,61 +115,6 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
-
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
-
|
|
120
|
-
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
-
/**
|
|
122
|
-
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
-
*
|
|
124
|
-
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
-
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
-
*/
|
|
128
|
-
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
-
/**
|
|
130
|
-
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
-
*
|
|
132
|
-
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
-
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
-
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
-
*/
|
|
137
|
-
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
-
/**
|
|
139
|
-
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
-
*
|
|
141
|
-
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
-
*
|
|
143
|
-
* @param entity - The entity to attach the component to.
|
|
144
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
-
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
-
*/
|
|
148
|
-
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
-
/**
|
|
151
|
-
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
-
*
|
|
153
|
-
* @param entity - The target entity.
|
|
154
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
-
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
-
*/
|
|
158
|
-
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
-
*
|
|
165
|
-
* `amplitude` represents the aggregated signal strength.
|
|
166
|
-
* `bands` represents the processed frequency bands.
|
|
167
|
-
*/
|
|
168
|
-
export declare type AudioAnalysisView = {
|
|
169
|
-
amplitude: number;
|
|
170
|
-
bands: number[];
|
|
171
|
-
};
|
|
172
|
-
|
|
173
118
|
/** @public */
|
|
174
119
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
175
120
|
|
|
@@ -264,9 +209,6 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
264
209
|
/** @public */
|
|
265
210
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
266
211
|
|
|
267
|
-
/** @public */
|
|
268
|
-
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
-
|
|
270
212
|
/** @public */
|
|
271
213
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
272
214
|
|
|
@@ -1379,7 +1321,6 @@ export declare const componentDefinitionByName: {
|
|
|
1379
1321
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1380
1322
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1381
1323
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
-
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1383
1324
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1384
1325
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1385
1326
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1387,7 +1328,6 @@ export declare const componentDefinitionByName: {
|
|
|
1387
1328
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1388
1329
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1389
1330
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
-
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1391
1331
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1392
1332
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1393
1333
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2094,7 +2034,6 @@ export declare type EventSystemOptions = {
|
|
|
2094
2034
|
showFeedback?: boolean;
|
|
2095
2035
|
showHighlight?: boolean;
|
|
2096
2036
|
maxPlayerDistance?: number;
|
|
2097
|
-
priority?: number;
|
|
2098
2037
|
};
|
|
2099
2038
|
|
|
2100
2039
|
/**
|
|
@@ -2266,6 +2205,15 @@ export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => Eve
|
|
|
2266
2205
|
*/
|
|
2267
2206
|
export declare function getEntitiesWithParent(engine: Pick<IEngine, 'getEntitiesWith' | 'defineComponentFromSchema'>, parent: Entity): Entity[];
|
|
2268
2207
|
|
|
2208
|
+
/**
|
|
2209
|
+
* Internal utilities for standardized globalThis access.
|
|
2210
|
+
*/
|
|
2211
|
+
/**
|
|
2212
|
+
* Type-safe globalThis property access.
|
|
2213
|
+
* @public
|
|
2214
|
+
*/
|
|
2215
|
+
export declare function getGlobal<T>(key: string): T | undefined;
|
|
2216
|
+
|
|
2269
2217
|
/**
|
|
2270
2218
|
* Get the world position of an entity, taking into account the full parent hierarchy.
|
|
2271
2219
|
* This computes the world-space position by accumulating all parent transforms
|
|
@@ -2748,8 +2696,7 @@ export declare const enum InputAction {
|
|
|
2748
2696
|
IA_ACTION_3 = 10,
|
|
2749
2697
|
IA_ACTION_4 = 11,
|
|
2750
2698
|
IA_ACTION_5 = 12,
|
|
2751
|
-
IA_ACTION_6 = 13
|
|
2752
|
-
IA_MODIFIER = 14
|
|
2699
|
+
IA_ACTION_6 = 13
|
|
2753
2700
|
}
|
|
2754
2701
|
|
|
2755
2702
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2797,14 +2744,6 @@ export declare type InstanceCompositeOptions = {
|
|
|
2797
2744
|
alreadyRequestedSrc?: Set<string>;
|
|
2798
2745
|
};
|
|
2799
2746
|
|
|
2800
|
-
/**
|
|
2801
|
-
* @public
|
|
2802
|
-
*/
|
|
2803
|
-
export declare const enum InteractionType {
|
|
2804
|
-
CURSOR = 0,
|
|
2805
|
-
PROXIMITY = 1
|
|
2806
|
-
}
|
|
2807
|
-
|
|
2808
2747
|
/**
|
|
2809
2748
|
* @public
|
|
2810
2749
|
*/
|
|
@@ -4504,45 +4443,6 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4504
4443
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4505
4444
|
}
|
|
4506
4445
|
|
|
4507
|
-
/**
|
|
4508
|
-
* @public
|
|
4509
|
-
*/
|
|
4510
|
-
export declare interface PBAudioAnalysis {
|
|
4511
|
-
/** Parameters section */
|
|
4512
|
-
mode: PBAudioAnalysisMode;
|
|
4513
|
-
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4514
|
-
amplitudeGain?: number | undefined;
|
|
4515
|
-
/** End when mode == MODE_LOGARITHMIC */
|
|
4516
|
-
bandsGain?: number | undefined;
|
|
4517
|
-
/** Result section */
|
|
4518
|
-
amplitude: number;
|
|
4519
|
-
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4520
|
-
band0: number;
|
|
4521
|
-
band1: number;
|
|
4522
|
-
band2: number;
|
|
4523
|
-
band3: number;
|
|
4524
|
-
band4: number;
|
|
4525
|
-
band5: number;
|
|
4526
|
-
band6: number;
|
|
4527
|
-
band7: number;
|
|
4528
|
-
}
|
|
4529
|
-
|
|
4530
|
-
/**
|
|
4531
|
-
* @public
|
|
4532
|
-
*/
|
|
4533
|
-
export declare namespace PBAudioAnalysis {
|
|
4534
|
-
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4535
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4536
|
-
}
|
|
4537
|
-
|
|
4538
|
-
/**
|
|
4539
|
-
* @public
|
|
4540
|
-
*/
|
|
4541
|
-
export declare const enum PBAudioAnalysisMode {
|
|
4542
|
-
MODE_RAW = 0,
|
|
4543
|
-
MODE_LOGARITHMIC = 1
|
|
4544
|
-
}
|
|
4545
|
-
|
|
4546
4446
|
/**
|
|
4547
4447
|
* @public
|
|
4548
4448
|
*/
|
|
@@ -4732,42 +4632,6 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4732
4632
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4733
4633
|
}
|
|
4734
4634
|
|
|
4735
|
-
/**
|
|
4736
|
-
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4737
|
-
* as the avatar movement speed, jump height etc.
|
|
4738
|
-
*/
|
|
4739
|
-
/**
|
|
4740
|
-
* @public
|
|
4741
|
-
*/
|
|
4742
|
-
export declare interface PBAvatarLocomotionSettings {
|
|
4743
|
-
/** Maximum speed when walking (in meters per second) */
|
|
4744
|
-
walkSpeed?: number | undefined;
|
|
4745
|
-
/** Maximum speed when jogging (in meters per second) */
|
|
4746
|
-
jogSpeed?: number | undefined;
|
|
4747
|
-
/** Maximum speed when running (in meters per second) */
|
|
4748
|
-
runSpeed?: number | undefined;
|
|
4749
|
-
/** Height of a regular jump (in meters) */
|
|
4750
|
-
jumpHeight?: number | undefined;
|
|
4751
|
-
/** Height of a jump while running (in meters) */
|
|
4752
|
-
runJumpHeight?: number | undefined;
|
|
4753
|
-
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4754
|
-
hardLandingCooldown?: number | undefined;
|
|
4755
|
-
/** Height of the double jump (in meters) */
|
|
4756
|
-
doubleJumpHeight?: number | undefined;
|
|
4757
|
-
/** Maximum speed when gliding (in meters per second) */
|
|
4758
|
-
glidingSpeed?: number | undefined;
|
|
4759
|
-
/** Maximum falling speed when gliding (in meters per second) */
|
|
4760
|
-
glidingFallingSpeed?: number | undefined;
|
|
4761
|
-
}
|
|
4762
|
-
|
|
4763
|
-
/**
|
|
4764
|
-
* @public
|
|
4765
|
-
*/
|
|
4766
|
-
export declare namespace PBAvatarLocomotionSettings {
|
|
4767
|
-
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4768
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4769
|
-
}
|
|
4770
|
-
|
|
4771
4635
|
/**
|
|
4772
4636
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4773
4637
|
* avatar behavior changes.
|
|
@@ -5675,8 +5539,6 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5675
5539
|
eventType: PointerEventType;
|
|
5676
5540
|
/** additional configuration for this detection */
|
|
5677
5541
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5678
|
-
/** the type of interaction source (default 0 == CURSOR) */
|
|
5679
|
-
interactionType?: InteractionType | undefined;
|
|
5680
5542
|
}
|
|
5681
5543
|
|
|
5682
5544
|
/**
|
|
@@ -5703,8 +5565,6 @@ export declare interface PBPointerEvents_Info {
|
|
|
5703
5565
|
showHighlight?: boolean | undefined;
|
|
5704
5566
|
/** range of interaction from the avatar's position (default 0) */
|
|
5705
5567
|
maxPlayerDistance?: number | undefined;
|
|
5706
|
-
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5707
|
-
priority?: number | undefined;
|
|
5708
5568
|
}
|
|
5709
5569
|
|
|
5710
5570
|
/**
|
|
@@ -6581,7 +6441,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6581
6441
|
* an 'instant' transition (like using speed/time = 0)
|
|
6582
6442
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6583
6443
|
* the holding entity transform).
|
|
6584
|
-
* * The fov defines the Field of View of the virtual camera
|
|
6585
6444
|
*/
|
|
6586
6445
|
/**
|
|
6587
6446
|
* @public
|
|
@@ -6589,8 +6448,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6589
6448
|
export declare interface PBVirtualCamera {
|
|
6590
6449
|
defaultTransition?: CameraTransition | undefined;
|
|
6591
6450
|
lookAtEntity?: number | undefined;
|
|
6592
|
-
/** default: 60 */
|
|
6593
|
-
fov?: number | undefined;
|
|
6594
6451
|
}
|
|
6595
6452
|
|
|
6596
6453
|
/**
|
|
@@ -6786,30 +6643,6 @@ export declare interface PointerEventsSystem {
|
|
|
6786
6643
|
* @param entity - Entity where the callback was attached
|
|
6787
6644
|
*/
|
|
6788
6645
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6789
|
-
/**
|
|
6790
|
-
* @public
|
|
6791
|
-
* Remove the callback for onProximityDown event
|
|
6792
|
-
* @param entity - Entity where the callback was attached
|
|
6793
|
-
*/
|
|
6794
|
-
removeOnProximityDown(entity: Entity): void;
|
|
6795
|
-
/**
|
|
6796
|
-
* @public
|
|
6797
|
-
* Remove the callback for onProximityUp event
|
|
6798
|
-
* @param entity - Entity where the callback was attached
|
|
6799
|
-
*/
|
|
6800
|
-
removeOnProximityUp(entity: Entity): void;
|
|
6801
|
-
/**
|
|
6802
|
-
* @public
|
|
6803
|
-
* Remove the callback for onProximityEnter event
|
|
6804
|
-
* @param entity - Entity where the callback was attached
|
|
6805
|
-
*/
|
|
6806
|
-
removeOnProximityEnter(entity: Entity): void;
|
|
6807
|
-
/**
|
|
6808
|
-
* @public
|
|
6809
|
-
* Remove the callback for onProximityLeave event
|
|
6810
|
-
* @param entity - Entity where the callback was attached
|
|
6811
|
-
*/
|
|
6812
|
-
removeOnProximityLeave(entity: Entity): void;
|
|
6813
6646
|
/**
|
|
6814
6647
|
* @public
|
|
6815
6648
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6864,46 +6697,6 @@ export declare interface PointerEventsSystem {
|
|
|
6864
6697
|
entity: Entity;
|
|
6865
6698
|
opts?: Partial<EventSystemOptions>;
|
|
6866
6699
|
}, cb: EventSystemCallback): void;
|
|
6867
|
-
/**
|
|
6868
|
-
* @public
|
|
6869
|
-
* Execute callback when the user presses the proximity button on the entity
|
|
6870
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6871
|
-
* @param cb - Function to execute when click fires
|
|
6872
|
-
*/
|
|
6873
|
-
onProximityDown(pointerData: {
|
|
6874
|
-
entity: Entity;
|
|
6875
|
-
opts?: Partial<EventSystemOptions>;
|
|
6876
|
-
}, cb: EventSystemCallback): void;
|
|
6877
|
-
/**
|
|
6878
|
-
* @public
|
|
6879
|
-
* Execute callback when the user releases the proximity button on the entity
|
|
6880
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6881
|
-
* @param cb - Function to execute when event fires
|
|
6882
|
-
*/
|
|
6883
|
-
onProximityUp(pointerData: {
|
|
6884
|
-
entity: Entity;
|
|
6885
|
-
opts?: Partial<EventSystemOptions>;
|
|
6886
|
-
}, cb: EventSystemCallback): void;
|
|
6887
|
-
/**
|
|
6888
|
-
* @public
|
|
6889
|
-
* Execute callback when the entity enters the proximity zone of the user
|
|
6890
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6891
|
-
* @param cb - Function to execute when event fires
|
|
6892
|
-
*/
|
|
6893
|
-
onProximityEnter(pointerData: {
|
|
6894
|
-
entity: Entity;
|
|
6895
|
-
opts?: Partial<EventSystemOptions>;
|
|
6896
|
-
}, cb: EventSystemCallback): void;
|
|
6897
|
-
/**
|
|
6898
|
-
* @public
|
|
6899
|
-
* Execute callback when the entity leaves the proximity zone of the user
|
|
6900
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6901
|
-
* @param cb - Function to execute when event fires
|
|
6902
|
-
*/
|
|
6903
|
-
onProximityLeave(pointerData: {
|
|
6904
|
-
entity: Entity;
|
|
6905
|
-
opts?: Partial<EventSystemOptions>;
|
|
6906
|
-
}, cb: EventSystemCallback): void;
|
|
6907
6700
|
}
|
|
6908
6701
|
|
|
6909
6702
|
/**
|
|
@@ -6920,9 +6713,7 @@ export declare const enum PointerEventType {
|
|
|
6920
6713
|
PET_UP = 0,
|
|
6921
6714
|
PET_DOWN = 1,
|
|
6922
6715
|
PET_HOVER_ENTER = 2,
|
|
6923
|
-
PET_HOVER_LEAVE = 3
|
|
6924
|
-
PET_PROXIMITY_ENTER = 4,
|
|
6925
|
-
PET_PROXIMITY_LEAVE = 5
|
|
6716
|
+
PET_HOVER_LEAVE = 3
|
|
6926
6717
|
}
|
|
6927
6718
|
|
|
6928
6719
|
/**
|
|
@@ -8139,6 +7930,12 @@ export declare namespace Schemas {
|
|
|
8139
7930
|
}) => void;
|
|
8140
7931
|
}
|
|
8141
7932
|
|
|
7933
|
+
/**
|
|
7934
|
+
* Sets a globalThis property as a polyfill (only if undefined/null).
|
|
7935
|
+
* @public
|
|
7936
|
+
*/
|
|
7937
|
+
export declare function setGlobalPolyfill<T>(key: string, value: T): void;
|
|
7938
|
+
|
|
8142
7939
|
/**
|
|
8143
7940
|
* @public
|
|
8144
7941
|
* Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
|