@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/beta.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
|
|
@@ -2739,8 +2687,7 @@ export declare const enum InputAction {
|
|
|
2739
2687
|
IA_ACTION_3 = 10,
|
|
2740
2688
|
IA_ACTION_4 = 11,
|
|
2741
2689
|
IA_ACTION_5 = 12,
|
|
2742
|
-
IA_ACTION_6 = 13
|
|
2743
|
-
IA_MODIFIER = 14
|
|
2690
|
+
IA_ACTION_6 = 13
|
|
2744
2691
|
}
|
|
2745
2692
|
|
|
2746
2693
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2788,14 +2735,6 @@ export declare type InstanceCompositeOptions = {
|
|
|
2788
2735
|
alreadyRequestedSrc?: Set<string>;
|
|
2789
2736
|
};
|
|
2790
2737
|
|
|
2791
|
-
/**
|
|
2792
|
-
* @public
|
|
2793
|
-
*/
|
|
2794
|
-
export declare const enum InteractionType {
|
|
2795
|
-
CURSOR = 0,
|
|
2796
|
-
PROXIMITY = 1
|
|
2797
|
-
}
|
|
2798
|
-
|
|
2799
2738
|
/**
|
|
2800
2739
|
* @public
|
|
2801
2740
|
*/
|
|
@@ -4476,45 +4415,6 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4476
4415
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4477
4416
|
}
|
|
4478
4417
|
|
|
4479
|
-
/**
|
|
4480
|
-
* @public
|
|
4481
|
-
*/
|
|
4482
|
-
export declare interface PBAudioAnalysis {
|
|
4483
|
-
/** Parameters section */
|
|
4484
|
-
mode: PBAudioAnalysisMode;
|
|
4485
|
-
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4486
|
-
amplitudeGain?: number | undefined;
|
|
4487
|
-
/** End when mode == MODE_LOGARITHMIC */
|
|
4488
|
-
bandsGain?: number | undefined;
|
|
4489
|
-
/** Result section */
|
|
4490
|
-
amplitude: number;
|
|
4491
|
-
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4492
|
-
band0: number;
|
|
4493
|
-
band1: number;
|
|
4494
|
-
band2: number;
|
|
4495
|
-
band3: number;
|
|
4496
|
-
band4: number;
|
|
4497
|
-
band5: number;
|
|
4498
|
-
band6: number;
|
|
4499
|
-
band7: number;
|
|
4500
|
-
}
|
|
4501
|
-
|
|
4502
|
-
/**
|
|
4503
|
-
* @public
|
|
4504
|
-
*/
|
|
4505
|
-
export declare namespace PBAudioAnalysis {
|
|
4506
|
-
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4507
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4508
|
-
}
|
|
4509
|
-
|
|
4510
|
-
/**
|
|
4511
|
-
* @public
|
|
4512
|
-
*/
|
|
4513
|
-
export declare const enum PBAudioAnalysisMode {
|
|
4514
|
-
MODE_RAW = 0,
|
|
4515
|
-
MODE_LOGARITHMIC = 1
|
|
4516
|
-
}
|
|
4517
|
-
|
|
4518
4418
|
/**
|
|
4519
4419
|
* @public
|
|
4520
4420
|
*/
|
|
@@ -4704,42 +4604,6 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4704
4604
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4705
4605
|
}
|
|
4706
4606
|
|
|
4707
|
-
/**
|
|
4708
|
-
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4709
|
-
* as the avatar movement speed, jump height etc.
|
|
4710
|
-
*/
|
|
4711
|
-
/**
|
|
4712
|
-
* @public
|
|
4713
|
-
*/
|
|
4714
|
-
export declare interface PBAvatarLocomotionSettings {
|
|
4715
|
-
/** Maximum speed when walking (in meters per second) */
|
|
4716
|
-
walkSpeed?: number | undefined;
|
|
4717
|
-
/** Maximum speed when jogging (in meters per second) */
|
|
4718
|
-
jogSpeed?: number | undefined;
|
|
4719
|
-
/** Maximum speed when running (in meters per second) */
|
|
4720
|
-
runSpeed?: number | undefined;
|
|
4721
|
-
/** Height of a regular jump (in meters) */
|
|
4722
|
-
jumpHeight?: number | undefined;
|
|
4723
|
-
/** Height of a jump while running (in meters) */
|
|
4724
|
-
runJumpHeight?: number | undefined;
|
|
4725
|
-
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4726
|
-
hardLandingCooldown?: number | undefined;
|
|
4727
|
-
/** Height of the double jump (in meters) */
|
|
4728
|
-
doubleJumpHeight?: number | undefined;
|
|
4729
|
-
/** Maximum speed when gliding (in meters per second) */
|
|
4730
|
-
glidingSpeed?: number | undefined;
|
|
4731
|
-
/** Maximum falling speed when gliding (in meters per second) */
|
|
4732
|
-
glidingFallingSpeed?: number | undefined;
|
|
4733
|
-
}
|
|
4734
|
-
|
|
4735
|
-
/**
|
|
4736
|
-
* @public
|
|
4737
|
-
*/
|
|
4738
|
-
export declare namespace PBAvatarLocomotionSettings {
|
|
4739
|
-
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4740
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4741
|
-
}
|
|
4742
|
-
|
|
4743
4607
|
/**
|
|
4744
4608
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4745
4609
|
* avatar behavior changes.
|
|
@@ -5647,8 +5511,6 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5647
5511
|
eventType: PointerEventType;
|
|
5648
5512
|
/** additional configuration for this detection */
|
|
5649
5513
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5650
|
-
/** the type of interaction source (default 0 == CURSOR) */
|
|
5651
|
-
interactionType?: InteractionType | undefined;
|
|
5652
5514
|
}
|
|
5653
5515
|
|
|
5654
5516
|
/**
|
|
@@ -5675,8 +5537,6 @@ export declare interface PBPointerEvents_Info {
|
|
|
5675
5537
|
showHighlight?: boolean | undefined;
|
|
5676
5538
|
/** range of interaction from the avatar's position (default 0) */
|
|
5677
5539
|
maxPlayerDistance?: number | undefined;
|
|
5678
|
-
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5679
|
-
priority?: number | undefined;
|
|
5680
5540
|
}
|
|
5681
5541
|
|
|
5682
5542
|
/**
|
|
@@ -6553,7 +6413,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6553
6413
|
* an 'instant' transition (like using speed/time = 0)
|
|
6554
6414
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6555
6415
|
* the holding entity transform).
|
|
6556
|
-
* * The fov defines the Field of View of the virtual camera
|
|
6557
6416
|
*/
|
|
6558
6417
|
/**
|
|
6559
6418
|
* @public
|
|
@@ -6561,8 +6420,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6561
6420
|
export declare interface PBVirtualCamera {
|
|
6562
6421
|
defaultTransition?: CameraTransition | undefined;
|
|
6563
6422
|
lookAtEntity?: number | undefined;
|
|
6564
|
-
/** default: 60 */
|
|
6565
|
-
fov?: number | undefined;
|
|
6566
6423
|
}
|
|
6567
6424
|
|
|
6568
6425
|
/**
|
|
@@ -6758,30 +6615,6 @@ export declare interface PointerEventsSystem {
|
|
|
6758
6615
|
* @param entity - Entity where the callback was attached
|
|
6759
6616
|
*/
|
|
6760
6617
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6761
|
-
/**
|
|
6762
|
-
* @public
|
|
6763
|
-
* Remove the callback for onProximityDown event
|
|
6764
|
-
* @param entity - Entity where the callback was attached
|
|
6765
|
-
*/
|
|
6766
|
-
removeOnProximityDown(entity: Entity): void;
|
|
6767
|
-
/**
|
|
6768
|
-
* @public
|
|
6769
|
-
* Remove the callback for onProximityUp event
|
|
6770
|
-
* @param entity - Entity where the callback was attached
|
|
6771
|
-
*/
|
|
6772
|
-
removeOnProximityUp(entity: Entity): void;
|
|
6773
|
-
/**
|
|
6774
|
-
* @public
|
|
6775
|
-
* Remove the callback for onProximityEnter event
|
|
6776
|
-
* @param entity - Entity where the callback was attached
|
|
6777
|
-
*/
|
|
6778
|
-
removeOnProximityEnter(entity: Entity): void;
|
|
6779
|
-
/**
|
|
6780
|
-
* @public
|
|
6781
|
-
* Remove the callback for onProximityLeave event
|
|
6782
|
-
* @param entity - Entity where the callback was attached
|
|
6783
|
-
*/
|
|
6784
|
-
removeOnProximityLeave(entity: Entity): void;
|
|
6785
6618
|
/**
|
|
6786
6619
|
* @public
|
|
6787
6620
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6836,46 +6669,6 @@ export declare interface PointerEventsSystem {
|
|
|
6836
6669
|
entity: Entity;
|
|
6837
6670
|
opts?: Partial<EventSystemOptions>;
|
|
6838
6671
|
}, cb: EventSystemCallback): void;
|
|
6839
|
-
/**
|
|
6840
|
-
* @public
|
|
6841
|
-
* Execute callback when the user presses the proximity button on the entity
|
|
6842
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6843
|
-
* @param cb - Function to execute when click fires
|
|
6844
|
-
*/
|
|
6845
|
-
onProximityDown(pointerData: {
|
|
6846
|
-
entity: Entity;
|
|
6847
|
-
opts?: Partial<EventSystemOptions>;
|
|
6848
|
-
}, cb: EventSystemCallback): void;
|
|
6849
|
-
/**
|
|
6850
|
-
* @public
|
|
6851
|
-
* Execute callback when the user releases the proximity button on the entity
|
|
6852
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6853
|
-
* @param cb - Function to execute when event fires
|
|
6854
|
-
*/
|
|
6855
|
-
onProximityUp(pointerData: {
|
|
6856
|
-
entity: Entity;
|
|
6857
|
-
opts?: Partial<EventSystemOptions>;
|
|
6858
|
-
}, cb: EventSystemCallback): void;
|
|
6859
|
-
/**
|
|
6860
|
-
* @public
|
|
6861
|
-
* Execute callback when the entity enters the proximity zone of the user
|
|
6862
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6863
|
-
* @param cb - Function to execute when event fires
|
|
6864
|
-
*/
|
|
6865
|
-
onProximityEnter(pointerData: {
|
|
6866
|
-
entity: Entity;
|
|
6867
|
-
opts?: Partial<EventSystemOptions>;
|
|
6868
|
-
}, cb: EventSystemCallback): void;
|
|
6869
|
-
/**
|
|
6870
|
-
* @public
|
|
6871
|
-
* Execute callback when the entity leaves the proximity zone of the user
|
|
6872
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6873
|
-
* @param cb - Function to execute when event fires
|
|
6874
|
-
*/
|
|
6875
|
-
onProximityLeave(pointerData: {
|
|
6876
|
-
entity: Entity;
|
|
6877
|
-
opts?: Partial<EventSystemOptions>;
|
|
6878
|
-
}, cb: EventSystemCallback): void;
|
|
6879
6672
|
}
|
|
6880
6673
|
|
|
6881
6674
|
/**
|
|
@@ -6892,9 +6685,7 @@ export declare const enum PointerEventType {
|
|
|
6892
6685
|
PET_UP = 0,
|
|
6893
6686
|
PET_DOWN = 1,
|
|
6894
6687
|
PET_HOVER_ENTER = 2,
|
|
6895
|
-
PET_HOVER_LEAVE = 3
|
|
6896
|
-
PET_PROXIMITY_ENTER = 4,
|
|
6897
|
-
PET_PROXIMITY_LEAVE = 5
|
|
6688
|
+
PET_HOVER_LEAVE = 3
|
|
6898
6689
|
}
|
|
6899
6690
|
|
|
6900
6691
|
/**
|
|
@@ -8111,6 +7902,12 @@ export declare namespace Schemas {
|
|
|
8111
7902
|
}) => void;
|
|
8112
7903
|
}
|
|
8113
7904
|
|
|
7905
|
+
/**
|
|
7906
|
+
* Sets a globalThis property as a polyfill (only if undefined/null).
|
|
7907
|
+
* @public
|
|
7908
|
+
*/
|
|
7909
|
+
export declare function setGlobalPolyfill<T>(key: string, value: T): void;
|
|
7910
|
+
|
|
8114
7911
|
/**
|
|
8115
7912
|
* @public
|
|
8116
7913
|
* Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
|