@dcl/playground-assets 7.20.4-22623908379.commit-46ce898 → 7.20.5-22631826546.commit-7c189f5
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 +421 -2
- package/dist/beta.d.ts +421 -2
- package/dist/index.bundled.d.ts +421 -2
- 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 +14 -7
- package/dist/playground-assets.d.ts +421 -2
- package/etc/playground-assets.api.json +5629 -1464
- package/etc/playground-assets.api.md +265 -0
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -115,6 +115,61 @@ 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
|
+
|
|
118
173
|
/** @public */
|
|
119
174
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
120
175
|
|
|
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
209
264
|
/** @public */
|
|
210
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
212
270
|
/** @public */
|
|
213
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
272
|
|
|
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1321
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1322
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1323
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1324
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1325
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1326
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -1344,6 +1404,8 @@ export declare const componentDefinitionByName: {
|
|
|
1344
1404
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
|
1345
1405
|
"core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
|
|
1346
1406
|
"core::NftShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBNftShape>>;
|
|
1407
|
+
"core::PhysicsCombinedForce": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>>;
|
|
1408
|
+
"core::PhysicsCombinedImpulse": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>>;
|
|
1347
1409
|
"core::PlayerIdentityData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPlayerIdentityData>>;
|
|
1348
1410
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
|
1349
1411
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
|
@@ -2032,6 +2094,7 @@ export declare type EventSystemOptions = {
|
|
|
2032
2094
|
showFeedback?: boolean;
|
|
2033
2095
|
showHighlight?: boolean;
|
|
2034
2096
|
maxPlayerDistance?: number;
|
|
2097
|
+
priority?: number;
|
|
2035
2098
|
};
|
|
2036
2099
|
|
|
2037
2100
|
/**
|
|
@@ -2685,7 +2748,8 @@ export declare const enum InputAction {
|
|
|
2685
2748
|
IA_ACTION_3 = 10,
|
|
2686
2749
|
IA_ACTION_4 = 11,
|
|
2687
2750
|
IA_ACTION_5 = 12,
|
|
2688
|
-
IA_ACTION_6 = 13
|
|
2751
|
+
IA_ACTION_6 = 13,
|
|
2752
|
+
IA_MODIFIER = 14
|
|
2689
2753
|
}
|
|
2690
2754
|
|
|
2691
2755
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2733,6 +2797,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2733
2797
|
alreadyRequestedSrc?: Set<string>;
|
|
2734
2798
|
};
|
|
2735
2799
|
|
|
2800
|
+
/**
|
|
2801
|
+
* @public
|
|
2802
|
+
*/
|
|
2803
|
+
export declare const enum InteractionType {
|
|
2804
|
+
CURSOR = 0,
|
|
2805
|
+
PROXIMITY = 1
|
|
2806
|
+
}
|
|
2807
|
+
|
|
2736
2808
|
/**
|
|
2737
2809
|
* @public
|
|
2738
2810
|
*/
|
|
@@ -3911,6 +3983,88 @@ export declare namespace MoveContinuous {
|
|
|
3911
3983
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3912
3984
|
}
|
|
3913
3985
|
|
|
3986
|
+
/**
|
|
3987
|
+
* @public
|
|
3988
|
+
*/
|
|
3989
|
+
export declare interface MoveRotateScale {
|
|
3990
|
+
positionStart: PBVector3 | undefined;
|
|
3991
|
+
positionEnd: PBVector3 | undefined;
|
|
3992
|
+
rotationStart: PBQuaternion | undefined;
|
|
3993
|
+
rotationEnd: PBQuaternion | undefined;
|
|
3994
|
+
scaleStart: PBVector3 | undefined;
|
|
3995
|
+
scaleEnd: PBVector3 | undefined;
|
|
3996
|
+
}
|
|
3997
|
+
|
|
3998
|
+
/**
|
|
3999
|
+
* @public
|
|
4000
|
+
*/
|
|
4001
|
+
export declare namespace MoveRotateScale {
|
|
4002
|
+
export function encode(message: MoveRotateScale, writer?: _m0.Writer): _m0.Writer;
|
|
4003
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScale;
|
|
4004
|
+
}
|
|
4005
|
+
|
|
4006
|
+
/**
|
|
4007
|
+
* @public
|
|
4008
|
+
*/
|
|
4009
|
+
export declare interface MoveRotateScaleContinuous {
|
|
4010
|
+
positionDirection: PBVector3 | undefined;
|
|
4011
|
+
rotationDirection: PBQuaternion | undefined;
|
|
4012
|
+
scaleDirection: PBVector3 | undefined;
|
|
4013
|
+
speed: number;
|
|
4014
|
+
}
|
|
4015
|
+
|
|
4016
|
+
/**
|
|
4017
|
+
* @public
|
|
4018
|
+
*/
|
|
4019
|
+
export declare namespace MoveRotateScaleContinuous {
|
|
4020
|
+
export function encode(message: MoveRotateScaleContinuous, writer?: _m0.Writer): _m0.Writer;
|
|
4021
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScaleContinuous;
|
|
4022
|
+
}
|
|
4023
|
+
|
|
4024
|
+
/**
|
|
4025
|
+
* @public
|
|
4026
|
+
* Partial params for Tween.Mode.MoveRotateScaleContinuous(). At least one of position, rotation, or scale must be provided.
|
|
4027
|
+
*/
|
|
4028
|
+
export declare interface MoveRotateScaleContinuousModeParams {
|
|
4029
|
+
/** Position direction for continuous movement. Optional. */
|
|
4030
|
+
position?: {
|
|
4031
|
+
direction: PBVector3;
|
|
4032
|
+
};
|
|
4033
|
+
/** Rotation direction for continuous rotation. Optional. */
|
|
4034
|
+
rotation?: {
|
|
4035
|
+
direction: PBQuaternion;
|
|
4036
|
+
};
|
|
4037
|
+
/** Scale direction for continuous scale change. Optional. */
|
|
4038
|
+
scale?: {
|
|
4039
|
+
direction: PBVector3;
|
|
4040
|
+
};
|
|
4041
|
+
/** Speed of the animation per second. */
|
|
4042
|
+
speed: number;
|
|
4043
|
+
}
|
|
4044
|
+
|
|
4045
|
+
/**
|
|
4046
|
+
* @public
|
|
4047
|
+
* Partial params for Tween.Mode.MoveRotateScale(). At least one of position, rotation, or scale must be provided.
|
|
4048
|
+
* Use this when building a mode for Tween.createOrReplace() or TweenSequence (e.g. only positionStart/positionEnd).
|
|
4049
|
+
*/
|
|
4050
|
+
export declare interface MoveRotateScaleModeParams {
|
|
4051
|
+
/** Position tween (start → end). Optional. */
|
|
4052
|
+
position?: {
|
|
4053
|
+
start: PBVector3;
|
|
4054
|
+
end: PBVector3;
|
|
4055
|
+
};
|
|
4056
|
+
/** Rotation tween (start → end). Optional. */
|
|
4057
|
+
rotation?: {
|
|
4058
|
+
start: PBQuaternion;
|
|
4059
|
+
end: PBQuaternion;
|
|
4060
|
+
};
|
|
4061
|
+
/** Scale tween (start → end). Optional. */
|
|
4062
|
+
scale?: {
|
|
4063
|
+
start: PBVector3;
|
|
4064
|
+
end: PBVector3;
|
|
4065
|
+
};
|
|
4066
|
+
}
|
|
4067
|
+
|
|
3914
4068
|
export declare const Name: NameComponent;
|
|
3915
4069
|
|
|
3916
4070
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4389,6 +4543,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4389
4543
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4390
4544
|
}
|
|
4391
4545
|
|
|
4546
|
+
/**
|
|
4547
|
+
* @public
|
|
4548
|
+
*/
|
|
4549
|
+
export declare interface PBAudioAnalysis {
|
|
4550
|
+
/** Parameters section */
|
|
4551
|
+
mode: PBAudioAnalysisMode;
|
|
4552
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4553
|
+
amplitudeGain?: number | undefined;
|
|
4554
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4555
|
+
bandsGain?: number | undefined;
|
|
4556
|
+
/** Result section */
|
|
4557
|
+
amplitude: number;
|
|
4558
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4559
|
+
band0: number;
|
|
4560
|
+
band1: number;
|
|
4561
|
+
band2: number;
|
|
4562
|
+
band3: number;
|
|
4563
|
+
band4: number;
|
|
4564
|
+
band5: number;
|
|
4565
|
+
band6: number;
|
|
4566
|
+
band7: number;
|
|
4567
|
+
}
|
|
4568
|
+
|
|
4569
|
+
/**
|
|
4570
|
+
* @public
|
|
4571
|
+
*/
|
|
4572
|
+
export declare namespace PBAudioAnalysis {
|
|
4573
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4574
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4575
|
+
}
|
|
4576
|
+
|
|
4577
|
+
/**
|
|
4578
|
+
* @public
|
|
4579
|
+
*/
|
|
4580
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4581
|
+
MODE_RAW = 0,
|
|
4582
|
+
MODE_LOGARITHMIC = 1
|
|
4583
|
+
}
|
|
4584
|
+
|
|
4392
4585
|
/**
|
|
4393
4586
|
* @public
|
|
4394
4587
|
*/
|
|
@@ -4578,6 +4771,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4578
4771
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4579
4772
|
}
|
|
4580
4773
|
|
|
4774
|
+
/**
|
|
4775
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4776
|
+
* as the avatar movement speed, jump height etc.
|
|
4777
|
+
*/
|
|
4778
|
+
/**
|
|
4779
|
+
* @public
|
|
4780
|
+
*/
|
|
4781
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4782
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4783
|
+
walkSpeed?: number | undefined;
|
|
4784
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4785
|
+
jogSpeed?: number | undefined;
|
|
4786
|
+
/** Maximum speed when running (in meters per second) */
|
|
4787
|
+
runSpeed?: number | undefined;
|
|
4788
|
+
/** Height of a regular jump (in meters) */
|
|
4789
|
+
jumpHeight?: number | undefined;
|
|
4790
|
+
/** Height of a jump while running (in meters) */
|
|
4791
|
+
runJumpHeight?: number | undefined;
|
|
4792
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4793
|
+
hardLandingCooldown?: number | undefined;
|
|
4794
|
+
/** Height of the double jump (in meters) */
|
|
4795
|
+
doubleJumpHeight?: number | undefined;
|
|
4796
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4797
|
+
glidingSpeed?: number | undefined;
|
|
4798
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4799
|
+
glidingFallingSpeed?: number | undefined;
|
|
4800
|
+
}
|
|
4801
|
+
|
|
4802
|
+
/**
|
|
4803
|
+
* @public
|
|
4804
|
+
*/
|
|
4805
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4806
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4807
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4808
|
+
}
|
|
4809
|
+
|
|
4581
4810
|
/**
|
|
4582
4811
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4583
4812
|
* avatar behavior changes.
|
|
@@ -4925,6 +5154,8 @@ export declare interface PBInputModifier_StandardInput {
|
|
|
4925
5154
|
disableRun?: boolean | undefined;
|
|
4926
5155
|
disableJump?: boolean | undefined;
|
|
4927
5156
|
disableEmote?: boolean | undefined;
|
|
5157
|
+
disableDoubleJump?: boolean | undefined;
|
|
5158
|
+
disableGliding?: boolean | undefined;
|
|
4928
5159
|
}
|
|
4929
5160
|
|
|
4930
5161
|
/**
|
|
@@ -5346,6 +5577,59 @@ export declare namespace PBNftShape {
|
|
|
5346
5577
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
|
|
5347
5578
|
}
|
|
5348
5579
|
|
|
5580
|
+
/**
|
|
5581
|
+
* This component applies a continuous physics force.
|
|
5582
|
+
*
|
|
5583
|
+
* @remarks Low-level component. Use Physics.applyForceToPlayer()/.removeForceToPlayer() instead.
|
|
5584
|
+
* Direct manipulation will conflict with the force accumulation registry.
|
|
5585
|
+
* Summary component: stores the accumulated result of all active forces registered by the scene in the current frame.
|
|
5586
|
+
*
|
|
5587
|
+
* State-like component: the force is applied every physics tick while the component is present on the entity.
|
|
5588
|
+
*/
|
|
5589
|
+
/**
|
|
5590
|
+
* @public
|
|
5591
|
+
*/
|
|
5592
|
+
export declare interface PBPhysicsCombinedForce {
|
|
5593
|
+
/** Includes force direction and magnitude */
|
|
5594
|
+
vector: PBVector3 | undefined;
|
|
5595
|
+
}
|
|
5596
|
+
|
|
5597
|
+
/**
|
|
5598
|
+
* @public
|
|
5599
|
+
*/
|
|
5600
|
+
export declare namespace PBPhysicsCombinedForce {
|
|
5601
|
+
export function encode(message: PBPhysicsCombinedForce, writer?: _m0.Writer): _m0.Writer;
|
|
5602
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPhysicsCombinedForce;
|
|
5603
|
+
}
|
|
5604
|
+
|
|
5605
|
+
/**
|
|
5606
|
+
* This component applies a one-shot physics summary impulse.
|
|
5607
|
+
*
|
|
5608
|
+
* @remarks Low-level component. Use Physics.applyImpulseToPlayer() instead.
|
|
5609
|
+
* Direct manipulation will conflict with the force accumulation registry.
|
|
5610
|
+
* Summary component: stores the accumulated result of all impulses registered by the scene in the current frame.
|
|
5611
|
+
*
|
|
5612
|
+
* Event-like component: each new impulse must increment the eventID to ensure delivery via CRDT, even if the direction is identical to the previous one.
|
|
5613
|
+
* Renderer processes impulse with the unique ID only once. Increase eventID of the component to apply another impulse.
|
|
5614
|
+
*/
|
|
5615
|
+
/**
|
|
5616
|
+
* @public
|
|
5617
|
+
*/
|
|
5618
|
+
export declare interface PBPhysicsCombinedImpulse {
|
|
5619
|
+
/** Includes impulse direction and magnitude */
|
|
5620
|
+
vector: PBVector3 | undefined;
|
|
5621
|
+
/** Monotonic counter to distinguish different impulses. */
|
|
5622
|
+
eventId: number;
|
|
5623
|
+
}
|
|
5624
|
+
|
|
5625
|
+
/**
|
|
5626
|
+
* @public
|
|
5627
|
+
*/
|
|
5628
|
+
export declare namespace PBPhysicsCombinedImpulse {
|
|
5629
|
+
export function encode(message: PBPhysicsCombinedImpulse, writer?: _m0.Writer): _m0.Writer;
|
|
5630
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPhysicsCombinedImpulse;
|
|
5631
|
+
}
|
|
5632
|
+
|
|
5349
5633
|
/**
|
|
5350
5634
|
* PlayerIdentityData is used to read the information about the avatar's
|
|
5351
5635
|
* identity. this component is written by the engine using the communications
|
|
@@ -5430,6 +5714,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5430
5714
|
eventType: PointerEventType;
|
|
5431
5715
|
/** additional configuration for this detection */
|
|
5432
5716
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5717
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5718
|
+
interactionType?: InteractionType | undefined;
|
|
5433
5719
|
}
|
|
5434
5720
|
|
|
5435
5721
|
/**
|
|
@@ -5456,6 +5742,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5456
5742
|
showHighlight?: boolean | undefined;
|
|
5457
5743
|
/** range of interaction from the avatar's position (default 0) */
|
|
5458
5744
|
maxPlayerDistance?: number | undefined;
|
|
5745
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5746
|
+
priority?: number | undefined;
|
|
5459
5747
|
}
|
|
5460
5748
|
|
|
5461
5749
|
/**
|
|
@@ -5892,6 +6180,12 @@ export declare interface PBTween {
|
|
|
5892
6180
|
} | {
|
|
5893
6181
|
$case: "textureMoveContinuous";
|
|
5894
6182
|
textureMoveContinuous: TextureMoveContinuous;
|
|
6183
|
+
} | {
|
|
6184
|
+
$case: "moveRotateScale";
|
|
6185
|
+
moveRotateScale: MoveRotateScale;
|
|
6186
|
+
} | {
|
|
6187
|
+
$case: "moveRotateScaleContinuous";
|
|
6188
|
+
moveRotateScaleContinuous: MoveRotateScaleContinuous;
|
|
5895
6189
|
} | undefined;
|
|
5896
6190
|
/** default true (pause or running) */
|
|
5897
6191
|
playing?: boolean | undefined;
|
|
@@ -6329,6 +6623,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6329
6623
|
* an 'instant' transition (like using speed/time = 0)
|
|
6330
6624
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6331
6625
|
* the holding entity transform).
|
|
6626
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6332
6627
|
*/
|
|
6333
6628
|
/**
|
|
6334
6629
|
* @public
|
|
@@ -6336,6 +6631,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6336
6631
|
export declare interface PBVirtualCamera {
|
|
6337
6632
|
defaultTransition?: CameraTransition | undefined;
|
|
6338
6633
|
lookAtEntity?: number | undefined;
|
|
6634
|
+
/** default: 60 */
|
|
6635
|
+
fov?: number | undefined;
|
|
6339
6636
|
}
|
|
6340
6637
|
|
|
6341
6638
|
/**
|
|
@@ -6370,6 +6667,12 @@ export declare namespace PBVisibilityComponent {
|
|
|
6370
6667
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6371
6668
|
}
|
|
6372
6669
|
|
|
6670
|
+
/** @public */
|
|
6671
|
+
export declare const PhysicsCombinedForce: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>;
|
|
6672
|
+
|
|
6673
|
+
/** @public */
|
|
6674
|
+
export declare const PhysicsCombinedImpulse: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>;
|
|
6675
|
+
|
|
6373
6676
|
/**
|
|
6374
6677
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6375
6678
|
* @public
|
|
@@ -6525,6 +6828,30 @@ export declare interface PointerEventsSystem {
|
|
|
6525
6828
|
* @param entity - Entity where the callback was attached
|
|
6526
6829
|
*/
|
|
6527
6830
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6831
|
+
/**
|
|
6832
|
+
* @public
|
|
6833
|
+
* Remove the callback for onProximityDown event
|
|
6834
|
+
* @param entity - Entity where the callback was attached
|
|
6835
|
+
*/
|
|
6836
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6837
|
+
/**
|
|
6838
|
+
* @public
|
|
6839
|
+
* Remove the callback for onProximityUp event
|
|
6840
|
+
* @param entity - Entity where the callback was attached
|
|
6841
|
+
*/
|
|
6842
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6843
|
+
/**
|
|
6844
|
+
* @public
|
|
6845
|
+
* Remove the callback for onProximityEnter event
|
|
6846
|
+
* @param entity - Entity where the callback was attached
|
|
6847
|
+
*/
|
|
6848
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6849
|
+
/**
|
|
6850
|
+
* @public
|
|
6851
|
+
* Remove the callback for onProximityLeave event
|
|
6852
|
+
* @param entity - Entity where the callback was attached
|
|
6853
|
+
*/
|
|
6854
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6528
6855
|
/**
|
|
6529
6856
|
* @public
|
|
6530
6857
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6579,6 +6906,46 @@ export declare interface PointerEventsSystem {
|
|
|
6579
6906
|
entity: Entity;
|
|
6580
6907
|
opts?: Partial<EventSystemOptions>;
|
|
6581
6908
|
}, cb: EventSystemCallback): void;
|
|
6909
|
+
/**
|
|
6910
|
+
* @public
|
|
6911
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6912
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6913
|
+
* @param cb - Function to execute when click fires
|
|
6914
|
+
*/
|
|
6915
|
+
onProximityDown(pointerData: {
|
|
6916
|
+
entity: Entity;
|
|
6917
|
+
opts?: Partial<EventSystemOptions>;
|
|
6918
|
+
}, cb: EventSystemCallback): void;
|
|
6919
|
+
/**
|
|
6920
|
+
* @public
|
|
6921
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6922
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6923
|
+
* @param cb - Function to execute when event fires
|
|
6924
|
+
*/
|
|
6925
|
+
onProximityUp(pointerData: {
|
|
6926
|
+
entity: Entity;
|
|
6927
|
+
opts?: Partial<EventSystemOptions>;
|
|
6928
|
+
}, cb: EventSystemCallback): void;
|
|
6929
|
+
/**
|
|
6930
|
+
* @public
|
|
6931
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6932
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6933
|
+
* @param cb - Function to execute when event fires
|
|
6934
|
+
*/
|
|
6935
|
+
onProximityEnter(pointerData: {
|
|
6936
|
+
entity: Entity;
|
|
6937
|
+
opts?: Partial<EventSystemOptions>;
|
|
6938
|
+
}, cb: EventSystemCallback): void;
|
|
6939
|
+
/**
|
|
6940
|
+
* @public
|
|
6941
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6942
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6943
|
+
* @param cb - Function to execute when event fires
|
|
6944
|
+
*/
|
|
6945
|
+
onProximityLeave(pointerData: {
|
|
6946
|
+
entity: Entity;
|
|
6947
|
+
opts?: Partial<EventSystemOptions>;
|
|
6948
|
+
}, cb: EventSystemCallback): void;
|
|
6582
6949
|
}
|
|
6583
6950
|
|
|
6584
6951
|
/**
|
|
@@ -6595,7 +6962,9 @@ export declare const enum PointerEventType {
|
|
|
6595
6962
|
PET_UP = 0,
|
|
6596
6963
|
PET_DOWN = 1,
|
|
6597
6964
|
PET_HOVER_ENTER = 2,
|
|
6598
|
-
PET_HOVER_LEAVE = 3
|
|
6965
|
+
PET_HOVER_LEAVE = 3,
|
|
6966
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6967
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6599
6968
|
}
|
|
6600
6969
|
|
|
6601
6970
|
/**
|
|
@@ -7812,6 +8181,26 @@ export declare namespace Schemas {
|
|
|
7812
8181
|
}) => void;
|
|
7813
8182
|
}
|
|
7814
8183
|
|
|
8184
|
+
/**
|
|
8185
|
+
* @public
|
|
8186
|
+
* Parameters for setMoveRotateScaleContinuous. At least one of position, rotation, or scale must be provided.
|
|
8187
|
+
*/
|
|
8188
|
+
export declare interface SetMoveRotateScaleContinuousParams extends MoveRotateScaleContinuousModeParams {
|
|
8189
|
+
/** Duration in milliseconds (defaults to 0 for infinite). */
|
|
8190
|
+
duration?: number;
|
|
8191
|
+
}
|
|
8192
|
+
|
|
8193
|
+
/**
|
|
8194
|
+
* @public
|
|
8195
|
+
* Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
|
|
8196
|
+
*/
|
|
8197
|
+
export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModeParams {
|
|
8198
|
+
/** Duration of the tween in milliseconds. */
|
|
8199
|
+
duration: number;
|
|
8200
|
+
/** Easing function (defaults to EF_LINEAR). */
|
|
8201
|
+
easingFunction?: EasingFunction;
|
|
8202
|
+
}
|
|
8203
|
+
|
|
7815
8204
|
/** @public */
|
|
7816
8205
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7817
8206
|
|
|
@@ -8413,6 +8802,26 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8413
8802
|
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8414
8803
|
*/
|
|
8415
8804
|
setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
|
|
8805
|
+
/**
|
|
8806
|
+
* @public
|
|
8807
|
+
*
|
|
8808
|
+
* Creates or replaces a move-rotate-scale tween component that simultaneously animates
|
|
8809
|
+
* an entity's position, rotation, and/or scale from start to end. Provide only the
|
|
8810
|
+
* properties you need (at least one of position, rotation, or scale).
|
|
8811
|
+
* @param entity - entity to apply the tween to
|
|
8812
|
+
* @param params - object with optional position, rotation, scale (each with start/end), duration, and optional easingFunction
|
|
8813
|
+
*/
|
|
8814
|
+
setMoveRotateScale(entity: Entity, params: SetMoveRotateScaleParams): void;
|
|
8815
|
+
/**
|
|
8816
|
+
* @public
|
|
8817
|
+
*
|
|
8818
|
+
* Creates or replaces a continuous move-rotate-scale tween component that simultaneously
|
|
8819
|
+
* moves, rotates, and/or scales an entity continuously. Provide only the properties
|
|
8820
|
+
* you need (at least one of position, rotation, or scale).
|
|
8821
|
+
* @param entity - entity to apply the tween to
|
|
8822
|
+
* @param params - object with optional position, rotation, scale (each with direction), speed, and optional duration
|
|
8823
|
+
*/
|
|
8824
|
+
setMoveRotateScaleContinuous(entity: Entity, params: SetMoveRotateScaleContinuousParams): void;
|
|
8416
8825
|
}
|
|
8417
8826
|
|
|
8418
8827
|
/**
|
|
@@ -8447,6 +8856,16 @@ export declare interface TweenHelper {
|
|
|
8447
8856
|
* @returns a texture-move-continuous mode tween
|
|
8448
8857
|
*/
|
|
8449
8858
|
TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
|
|
8859
|
+
/**
|
|
8860
|
+
* @returns a move-rotate-scale mode tween
|
|
8861
|
+
* @param params - partial transform (at least one of position, rotation, scale); omit axes you don't need
|
|
8862
|
+
*/
|
|
8863
|
+
MoveRotateScale: (params: MoveRotateScaleModeParams) => PBTween['mode'];
|
|
8864
|
+
/**
|
|
8865
|
+
* @returns a move-rotate-scale-continuous mode tween
|
|
8866
|
+
* @param params - partial transform (at least one of position, rotation, scale) + speed; omit axes you don't need
|
|
8867
|
+
*/
|
|
8868
|
+
MoveRotateScaleContinuous: (params: MoveRotateScaleContinuousModeParams) => PBTween['mode'];
|
|
8450
8869
|
}
|
|
8451
8870
|
|
|
8452
8871
|
/**
|