@dcl/playground-assets 7.20.4 → 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/beta.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
|
/**
|
|
@@ -2676,7 +2739,8 @@ export declare const enum InputAction {
|
|
|
2676
2739
|
IA_ACTION_3 = 10,
|
|
2677
2740
|
IA_ACTION_4 = 11,
|
|
2678
2741
|
IA_ACTION_5 = 12,
|
|
2679
|
-
IA_ACTION_6 = 13
|
|
2742
|
+
IA_ACTION_6 = 13,
|
|
2743
|
+
IA_MODIFIER = 14
|
|
2680
2744
|
}
|
|
2681
2745
|
|
|
2682
2746
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2724,6 +2788,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2724
2788
|
alreadyRequestedSrc?: Set<string>;
|
|
2725
2789
|
};
|
|
2726
2790
|
|
|
2791
|
+
/**
|
|
2792
|
+
* @public
|
|
2793
|
+
*/
|
|
2794
|
+
export declare const enum InteractionType {
|
|
2795
|
+
CURSOR = 0,
|
|
2796
|
+
PROXIMITY = 1
|
|
2797
|
+
}
|
|
2798
|
+
|
|
2727
2799
|
/**
|
|
2728
2800
|
* @public
|
|
2729
2801
|
*/
|
|
@@ -3891,6 +3963,88 @@ export declare namespace MoveContinuous {
|
|
|
3891
3963
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3892
3964
|
}
|
|
3893
3965
|
|
|
3966
|
+
/**
|
|
3967
|
+
* @public
|
|
3968
|
+
*/
|
|
3969
|
+
export declare interface MoveRotateScale {
|
|
3970
|
+
positionStart: PBVector3 | undefined;
|
|
3971
|
+
positionEnd: PBVector3 | undefined;
|
|
3972
|
+
rotationStart: PBQuaternion | undefined;
|
|
3973
|
+
rotationEnd: PBQuaternion | undefined;
|
|
3974
|
+
scaleStart: PBVector3 | undefined;
|
|
3975
|
+
scaleEnd: PBVector3 | undefined;
|
|
3976
|
+
}
|
|
3977
|
+
|
|
3978
|
+
/**
|
|
3979
|
+
* @public
|
|
3980
|
+
*/
|
|
3981
|
+
export declare namespace MoveRotateScale {
|
|
3982
|
+
export function encode(message: MoveRotateScale, writer?: _m0.Writer): _m0.Writer;
|
|
3983
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScale;
|
|
3984
|
+
}
|
|
3985
|
+
|
|
3986
|
+
/**
|
|
3987
|
+
* @public
|
|
3988
|
+
*/
|
|
3989
|
+
export declare interface MoveRotateScaleContinuous {
|
|
3990
|
+
positionDirection: PBVector3 | undefined;
|
|
3991
|
+
rotationDirection: PBQuaternion | undefined;
|
|
3992
|
+
scaleDirection: PBVector3 | undefined;
|
|
3993
|
+
speed: number;
|
|
3994
|
+
}
|
|
3995
|
+
|
|
3996
|
+
/**
|
|
3997
|
+
* @public
|
|
3998
|
+
*/
|
|
3999
|
+
export declare namespace MoveRotateScaleContinuous {
|
|
4000
|
+
export function encode(message: MoveRotateScaleContinuous, writer?: _m0.Writer): _m0.Writer;
|
|
4001
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScaleContinuous;
|
|
4002
|
+
}
|
|
4003
|
+
|
|
4004
|
+
/**
|
|
4005
|
+
* @public
|
|
4006
|
+
* Partial params for Tween.Mode.MoveRotateScaleContinuous(). At least one of position, rotation, or scale must be provided.
|
|
4007
|
+
*/
|
|
4008
|
+
export declare interface MoveRotateScaleContinuousModeParams {
|
|
4009
|
+
/** Position direction for continuous movement. Optional. */
|
|
4010
|
+
position?: {
|
|
4011
|
+
direction: PBVector3;
|
|
4012
|
+
};
|
|
4013
|
+
/** Rotation direction for continuous rotation. Optional. */
|
|
4014
|
+
rotation?: {
|
|
4015
|
+
direction: PBQuaternion;
|
|
4016
|
+
};
|
|
4017
|
+
/** Scale direction for continuous scale change. Optional. */
|
|
4018
|
+
scale?: {
|
|
4019
|
+
direction: PBVector3;
|
|
4020
|
+
};
|
|
4021
|
+
/** Speed of the animation per second. */
|
|
4022
|
+
speed: number;
|
|
4023
|
+
}
|
|
4024
|
+
|
|
4025
|
+
/**
|
|
4026
|
+
* @public
|
|
4027
|
+
* Partial params for Tween.Mode.MoveRotateScale(). At least one of position, rotation, or scale must be provided.
|
|
4028
|
+
* Use this when building a mode for Tween.createOrReplace() or TweenSequence (e.g. only positionStart/positionEnd).
|
|
4029
|
+
*/
|
|
4030
|
+
export declare interface MoveRotateScaleModeParams {
|
|
4031
|
+
/** Position tween (start → end). Optional. */
|
|
4032
|
+
position?: {
|
|
4033
|
+
start: PBVector3;
|
|
4034
|
+
end: PBVector3;
|
|
4035
|
+
};
|
|
4036
|
+
/** Rotation tween (start → end). Optional. */
|
|
4037
|
+
rotation?: {
|
|
4038
|
+
start: PBQuaternion;
|
|
4039
|
+
end: PBQuaternion;
|
|
4040
|
+
};
|
|
4041
|
+
/** Scale tween (start → end). Optional. */
|
|
4042
|
+
scale?: {
|
|
4043
|
+
start: PBVector3;
|
|
4044
|
+
end: PBVector3;
|
|
4045
|
+
};
|
|
4046
|
+
}
|
|
4047
|
+
|
|
3894
4048
|
export declare const Name: NameComponent;
|
|
3895
4049
|
|
|
3896
4050
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4361,6 +4515,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4361
4515
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4362
4516
|
}
|
|
4363
4517
|
|
|
4518
|
+
/**
|
|
4519
|
+
* @public
|
|
4520
|
+
*/
|
|
4521
|
+
export declare interface PBAudioAnalysis {
|
|
4522
|
+
/** Parameters section */
|
|
4523
|
+
mode: PBAudioAnalysisMode;
|
|
4524
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4525
|
+
amplitudeGain?: number | undefined;
|
|
4526
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4527
|
+
bandsGain?: number | undefined;
|
|
4528
|
+
/** Result section */
|
|
4529
|
+
amplitude: number;
|
|
4530
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4531
|
+
band0: number;
|
|
4532
|
+
band1: number;
|
|
4533
|
+
band2: number;
|
|
4534
|
+
band3: number;
|
|
4535
|
+
band4: number;
|
|
4536
|
+
band5: number;
|
|
4537
|
+
band6: number;
|
|
4538
|
+
band7: number;
|
|
4539
|
+
}
|
|
4540
|
+
|
|
4541
|
+
/**
|
|
4542
|
+
* @public
|
|
4543
|
+
*/
|
|
4544
|
+
export declare namespace PBAudioAnalysis {
|
|
4545
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4546
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4547
|
+
}
|
|
4548
|
+
|
|
4549
|
+
/**
|
|
4550
|
+
* @public
|
|
4551
|
+
*/
|
|
4552
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4553
|
+
MODE_RAW = 0,
|
|
4554
|
+
MODE_LOGARITHMIC = 1
|
|
4555
|
+
}
|
|
4556
|
+
|
|
4364
4557
|
/**
|
|
4365
4558
|
* @public
|
|
4366
4559
|
*/
|
|
@@ -4550,6 +4743,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4550
4743
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4551
4744
|
}
|
|
4552
4745
|
|
|
4746
|
+
/**
|
|
4747
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4748
|
+
* as the avatar movement speed, jump height etc.
|
|
4749
|
+
*/
|
|
4750
|
+
/**
|
|
4751
|
+
* @public
|
|
4752
|
+
*/
|
|
4753
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4754
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4755
|
+
walkSpeed?: number | undefined;
|
|
4756
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4757
|
+
jogSpeed?: number | undefined;
|
|
4758
|
+
/** Maximum speed when running (in meters per second) */
|
|
4759
|
+
runSpeed?: number | undefined;
|
|
4760
|
+
/** Height of a regular jump (in meters) */
|
|
4761
|
+
jumpHeight?: number | undefined;
|
|
4762
|
+
/** Height of a jump while running (in meters) */
|
|
4763
|
+
runJumpHeight?: number | undefined;
|
|
4764
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4765
|
+
hardLandingCooldown?: number | undefined;
|
|
4766
|
+
/** Height of the double jump (in meters) */
|
|
4767
|
+
doubleJumpHeight?: number | undefined;
|
|
4768
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4769
|
+
glidingSpeed?: number | undefined;
|
|
4770
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4771
|
+
glidingFallingSpeed?: number | undefined;
|
|
4772
|
+
}
|
|
4773
|
+
|
|
4774
|
+
/**
|
|
4775
|
+
* @public
|
|
4776
|
+
*/
|
|
4777
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4778
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4779
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4780
|
+
}
|
|
4781
|
+
|
|
4553
4782
|
/**
|
|
4554
4783
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4555
4784
|
* avatar behavior changes.
|
|
@@ -4897,6 +5126,8 @@ export declare interface PBInputModifier_StandardInput {
|
|
|
4897
5126
|
disableRun?: boolean | undefined;
|
|
4898
5127
|
disableJump?: boolean | undefined;
|
|
4899
5128
|
disableEmote?: boolean | undefined;
|
|
5129
|
+
disableDoubleJump?: boolean | undefined;
|
|
5130
|
+
disableGliding?: boolean | undefined;
|
|
4900
5131
|
}
|
|
4901
5132
|
|
|
4902
5133
|
/**
|
|
@@ -5318,6 +5549,59 @@ export declare namespace PBNftShape {
|
|
|
5318
5549
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
|
|
5319
5550
|
}
|
|
5320
5551
|
|
|
5552
|
+
/**
|
|
5553
|
+
* This component applies a continuous physics force.
|
|
5554
|
+
*
|
|
5555
|
+
* @remarks Low-level component. Use Physics.applyForceToPlayer()/.removeForceToPlayer() instead.
|
|
5556
|
+
* Direct manipulation will conflict with the force accumulation registry.
|
|
5557
|
+
* Summary component: stores the accumulated result of all active forces registered by the scene in the current frame.
|
|
5558
|
+
*
|
|
5559
|
+
* State-like component: the force is applied every physics tick while the component is present on the entity.
|
|
5560
|
+
*/
|
|
5561
|
+
/**
|
|
5562
|
+
* @public
|
|
5563
|
+
*/
|
|
5564
|
+
export declare interface PBPhysicsCombinedForce {
|
|
5565
|
+
/** Includes force direction and magnitude */
|
|
5566
|
+
vector: PBVector3 | undefined;
|
|
5567
|
+
}
|
|
5568
|
+
|
|
5569
|
+
/**
|
|
5570
|
+
* @public
|
|
5571
|
+
*/
|
|
5572
|
+
export declare namespace PBPhysicsCombinedForce {
|
|
5573
|
+
export function encode(message: PBPhysicsCombinedForce, writer?: _m0.Writer): _m0.Writer;
|
|
5574
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPhysicsCombinedForce;
|
|
5575
|
+
}
|
|
5576
|
+
|
|
5577
|
+
/**
|
|
5578
|
+
* This component applies a one-shot physics summary impulse.
|
|
5579
|
+
*
|
|
5580
|
+
* @remarks Low-level component. Use Physics.applyImpulseToPlayer() instead.
|
|
5581
|
+
* Direct manipulation will conflict with the force accumulation registry.
|
|
5582
|
+
* Summary component: stores the accumulated result of all impulses registered by the scene in the current frame.
|
|
5583
|
+
*
|
|
5584
|
+
* 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.
|
|
5585
|
+
* Renderer processes impulse with the unique ID only once. Increase eventID of the component to apply another impulse.
|
|
5586
|
+
*/
|
|
5587
|
+
/**
|
|
5588
|
+
* @public
|
|
5589
|
+
*/
|
|
5590
|
+
export declare interface PBPhysicsCombinedImpulse {
|
|
5591
|
+
/** Includes impulse direction and magnitude */
|
|
5592
|
+
vector: PBVector3 | undefined;
|
|
5593
|
+
/** Monotonic counter to distinguish different impulses. */
|
|
5594
|
+
eventId: number;
|
|
5595
|
+
}
|
|
5596
|
+
|
|
5597
|
+
/**
|
|
5598
|
+
* @public
|
|
5599
|
+
*/
|
|
5600
|
+
export declare namespace PBPhysicsCombinedImpulse {
|
|
5601
|
+
export function encode(message: PBPhysicsCombinedImpulse, writer?: _m0.Writer): _m0.Writer;
|
|
5602
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPhysicsCombinedImpulse;
|
|
5603
|
+
}
|
|
5604
|
+
|
|
5321
5605
|
/**
|
|
5322
5606
|
* PlayerIdentityData is used to read the information about the avatar's
|
|
5323
5607
|
* identity. this component is written by the engine using the communications
|
|
@@ -5402,6 +5686,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5402
5686
|
eventType: PointerEventType;
|
|
5403
5687
|
/** additional configuration for this detection */
|
|
5404
5688
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5689
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5690
|
+
interactionType?: InteractionType | undefined;
|
|
5405
5691
|
}
|
|
5406
5692
|
|
|
5407
5693
|
/**
|
|
@@ -5428,6 +5714,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5428
5714
|
showHighlight?: boolean | undefined;
|
|
5429
5715
|
/** range of interaction from the avatar's position (default 0) */
|
|
5430
5716
|
maxPlayerDistance?: number | undefined;
|
|
5717
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5718
|
+
priority?: number | undefined;
|
|
5431
5719
|
}
|
|
5432
5720
|
|
|
5433
5721
|
/**
|
|
@@ -5864,6 +6152,12 @@ export declare interface PBTween {
|
|
|
5864
6152
|
} | {
|
|
5865
6153
|
$case: "textureMoveContinuous";
|
|
5866
6154
|
textureMoveContinuous: TextureMoveContinuous;
|
|
6155
|
+
} | {
|
|
6156
|
+
$case: "moveRotateScale";
|
|
6157
|
+
moveRotateScale: MoveRotateScale;
|
|
6158
|
+
} | {
|
|
6159
|
+
$case: "moveRotateScaleContinuous";
|
|
6160
|
+
moveRotateScaleContinuous: MoveRotateScaleContinuous;
|
|
5867
6161
|
} | undefined;
|
|
5868
6162
|
/** default true (pause or running) */
|
|
5869
6163
|
playing?: boolean | undefined;
|
|
@@ -6301,6 +6595,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6301
6595
|
* an 'instant' transition (like using speed/time = 0)
|
|
6302
6596
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6303
6597
|
* the holding entity transform).
|
|
6598
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6304
6599
|
*/
|
|
6305
6600
|
/**
|
|
6306
6601
|
* @public
|
|
@@ -6308,6 +6603,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6308
6603
|
export declare interface PBVirtualCamera {
|
|
6309
6604
|
defaultTransition?: CameraTransition | undefined;
|
|
6310
6605
|
lookAtEntity?: number | undefined;
|
|
6606
|
+
/** default: 60 */
|
|
6607
|
+
fov?: number | undefined;
|
|
6311
6608
|
}
|
|
6312
6609
|
|
|
6313
6610
|
/**
|
|
@@ -6342,6 +6639,12 @@ export declare namespace PBVisibilityComponent {
|
|
|
6342
6639
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6343
6640
|
}
|
|
6344
6641
|
|
|
6642
|
+
/** @public */
|
|
6643
|
+
export declare const PhysicsCombinedForce: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>;
|
|
6644
|
+
|
|
6645
|
+
/** @public */
|
|
6646
|
+
export declare const PhysicsCombinedImpulse: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>;
|
|
6647
|
+
|
|
6345
6648
|
/**
|
|
6346
6649
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6347
6650
|
* @public
|
|
@@ -6497,6 +6800,30 @@ export declare interface PointerEventsSystem {
|
|
|
6497
6800
|
* @param entity - Entity where the callback was attached
|
|
6498
6801
|
*/
|
|
6499
6802
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6803
|
+
/**
|
|
6804
|
+
* @public
|
|
6805
|
+
* Remove the callback for onProximityDown event
|
|
6806
|
+
* @param entity - Entity where the callback was attached
|
|
6807
|
+
*/
|
|
6808
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6809
|
+
/**
|
|
6810
|
+
* @public
|
|
6811
|
+
* Remove the callback for onProximityUp event
|
|
6812
|
+
* @param entity - Entity where the callback was attached
|
|
6813
|
+
*/
|
|
6814
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6815
|
+
/**
|
|
6816
|
+
* @public
|
|
6817
|
+
* Remove the callback for onProximityEnter event
|
|
6818
|
+
* @param entity - Entity where the callback was attached
|
|
6819
|
+
*/
|
|
6820
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6821
|
+
/**
|
|
6822
|
+
* @public
|
|
6823
|
+
* Remove the callback for onProximityLeave event
|
|
6824
|
+
* @param entity - Entity where the callback was attached
|
|
6825
|
+
*/
|
|
6826
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6500
6827
|
/**
|
|
6501
6828
|
* @public
|
|
6502
6829
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6551,6 +6878,46 @@ export declare interface PointerEventsSystem {
|
|
|
6551
6878
|
entity: Entity;
|
|
6552
6879
|
opts?: Partial<EventSystemOptions>;
|
|
6553
6880
|
}, cb: EventSystemCallback): void;
|
|
6881
|
+
/**
|
|
6882
|
+
* @public
|
|
6883
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6884
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6885
|
+
* @param cb - Function to execute when click fires
|
|
6886
|
+
*/
|
|
6887
|
+
onProximityDown(pointerData: {
|
|
6888
|
+
entity: Entity;
|
|
6889
|
+
opts?: Partial<EventSystemOptions>;
|
|
6890
|
+
}, cb: EventSystemCallback): void;
|
|
6891
|
+
/**
|
|
6892
|
+
* @public
|
|
6893
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6894
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6895
|
+
* @param cb - Function to execute when event fires
|
|
6896
|
+
*/
|
|
6897
|
+
onProximityUp(pointerData: {
|
|
6898
|
+
entity: Entity;
|
|
6899
|
+
opts?: Partial<EventSystemOptions>;
|
|
6900
|
+
}, cb: EventSystemCallback): void;
|
|
6901
|
+
/**
|
|
6902
|
+
* @public
|
|
6903
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6904
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6905
|
+
* @param cb - Function to execute when event fires
|
|
6906
|
+
*/
|
|
6907
|
+
onProximityEnter(pointerData: {
|
|
6908
|
+
entity: Entity;
|
|
6909
|
+
opts?: Partial<EventSystemOptions>;
|
|
6910
|
+
}, cb: EventSystemCallback): void;
|
|
6911
|
+
/**
|
|
6912
|
+
* @public
|
|
6913
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6914
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6915
|
+
* @param cb - Function to execute when event fires
|
|
6916
|
+
*/
|
|
6917
|
+
onProximityLeave(pointerData: {
|
|
6918
|
+
entity: Entity;
|
|
6919
|
+
opts?: Partial<EventSystemOptions>;
|
|
6920
|
+
}, cb: EventSystemCallback): void;
|
|
6554
6921
|
}
|
|
6555
6922
|
|
|
6556
6923
|
/**
|
|
@@ -6567,7 +6934,9 @@ export declare const enum PointerEventType {
|
|
|
6567
6934
|
PET_UP = 0,
|
|
6568
6935
|
PET_DOWN = 1,
|
|
6569
6936
|
PET_HOVER_ENTER = 2,
|
|
6570
|
-
PET_HOVER_LEAVE = 3
|
|
6937
|
+
PET_HOVER_LEAVE = 3,
|
|
6938
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6939
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6571
6940
|
}
|
|
6572
6941
|
|
|
6573
6942
|
/**
|
|
@@ -7784,6 +8153,26 @@ export declare namespace Schemas {
|
|
|
7784
8153
|
}) => void;
|
|
7785
8154
|
}
|
|
7786
8155
|
|
|
8156
|
+
/**
|
|
8157
|
+
* @public
|
|
8158
|
+
* Parameters for setMoveRotateScaleContinuous. At least one of position, rotation, or scale must be provided.
|
|
8159
|
+
*/
|
|
8160
|
+
export declare interface SetMoveRotateScaleContinuousParams extends MoveRotateScaleContinuousModeParams {
|
|
8161
|
+
/** Duration in milliseconds (defaults to 0 for infinite). */
|
|
8162
|
+
duration?: number;
|
|
8163
|
+
}
|
|
8164
|
+
|
|
8165
|
+
/**
|
|
8166
|
+
* @public
|
|
8167
|
+
* Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
|
|
8168
|
+
*/
|
|
8169
|
+
export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModeParams {
|
|
8170
|
+
/** Duration of the tween in milliseconds. */
|
|
8171
|
+
duration: number;
|
|
8172
|
+
/** Easing function (defaults to EF_LINEAR). */
|
|
8173
|
+
easingFunction?: EasingFunction;
|
|
8174
|
+
}
|
|
8175
|
+
|
|
7787
8176
|
/** @public */
|
|
7788
8177
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7789
8178
|
|
|
@@ -8380,6 +8769,26 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8380
8769
|
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8381
8770
|
*/
|
|
8382
8771
|
setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
|
|
8772
|
+
/**
|
|
8773
|
+
* @public
|
|
8774
|
+
*
|
|
8775
|
+
* Creates or replaces a move-rotate-scale tween component that simultaneously animates
|
|
8776
|
+
* an entity's position, rotation, and/or scale from start to end. Provide only the
|
|
8777
|
+
* properties you need (at least one of position, rotation, or scale).
|
|
8778
|
+
* @param entity - entity to apply the tween to
|
|
8779
|
+
* @param params - object with optional position, rotation, scale (each with start/end), duration, and optional easingFunction
|
|
8780
|
+
*/
|
|
8781
|
+
setMoveRotateScale(entity: Entity, params: SetMoveRotateScaleParams): void;
|
|
8782
|
+
/**
|
|
8783
|
+
* @public
|
|
8784
|
+
*
|
|
8785
|
+
* Creates or replaces a continuous move-rotate-scale tween component that simultaneously
|
|
8786
|
+
* moves, rotates, and/or scales an entity continuously. Provide only the properties
|
|
8787
|
+
* you need (at least one of position, rotation, or scale).
|
|
8788
|
+
* @param entity - entity to apply the tween to
|
|
8789
|
+
* @param params - object with optional position, rotation, scale (each with direction), speed, and optional duration
|
|
8790
|
+
*/
|
|
8791
|
+
setMoveRotateScaleContinuous(entity: Entity, params: SetMoveRotateScaleContinuousParams): void;
|
|
8383
8792
|
}
|
|
8384
8793
|
|
|
8385
8794
|
/**
|
|
@@ -8414,6 +8823,16 @@ export declare interface TweenHelper {
|
|
|
8414
8823
|
* @returns a texture-move-continuous mode tween
|
|
8415
8824
|
*/
|
|
8416
8825
|
TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
|
|
8826
|
+
/**
|
|
8827
|
+
* @returns a move-rotate-scale mode tween
|
|
8828
|
+
* @param params - partial transform (at least one of position, rotation, scale); omit axes you don't need
|
|
8829
|
+
*/
|
|
8830
|
+
MoveRotateScale: (params: MoveRotateScaleModeParams) => PBTween['mode'];
|
|
8831
|
+
/**
|
|
8832
|
+
* @returns a move-rotate-scale-continuous mode tween
|
|
8833
|
+
* @param params - partial transform (at least one of position, rotation, scale) + speed; omit axes you don't need
|
|
8834
|
+
*/
|
|
8835
|
+
MoveRotateScaleContinuous: (params: MoveRotateScaleContinuousModeParams) => PBTween['mode'];
|
|
8417
8836
|
}
|
|
8418
8837
|
|
|
8419
8838
|
/**
|