@dcl/playground-assets 7.20.4-22581991550.commit-9c72184 → 7.20.4-22621752364.commit-d72981b
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 +351 -99
- package/dist/beta.d.ts +351 -99
- package/dist/index.bundled.d.ts +351 -99
- 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 +351 -99
- package/etc/playground-assets.api.json +6206 -3730
- package/etc/playground-assets.api.md +222 -75
- package/package.json +5 -6
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
|
|
|
@@ -163,42 +218,6 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
163
218
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
164
219
|
}
|
|
165
220
|
|
|
166
|
-
/**
|
|
167
|
-
* @public
|
|
168
|
-
*/
|
|
169
|
-
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
170
|
-
|
|
171
|
-
/**
|
|
172
|
-
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
173
|
-
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
174
|
-
*
|
|
175
|
-
* @param entity - Uint32 number of the entity
|
|
176
|
-
* @param componentId - Uint32 number of id
|
|
177
|
-
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
178
|
-
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
179
|
-
* @public
|
|
180
|
-
*/
|
|
181
|
-
export declare type AuthoritativePutComponentMessageBody = {
|
|
182
|
-
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
183
|
-
entityId: Entity;
|
|
184
|
-
componentId: number;
|
|
185
|
-
timestamp: number;
|
|
186
|
-
data: Uint8Array;
|
|
187
|
-
};
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* @public
|
|
191
|
-
*/
|
|
192
|
-
export declare namespace AuthoritativePutComponentOperation {
|
|
193
|
-
const MESSAGE_HEADER_LENGTH = 16;
|
|
194
|
-
/**
|
|
195
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
196
|
-
* already allocated
|
|
197
|
-
*/
|
|
198
|
-
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
199
|
-
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
200
|
-
}
|
|
201
|
-
|
|
202
221
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
203
222
|
/**
|
|
204
223
|
* @public
|
|
@@ -245,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
245
264
|
/** @public */
|
|
246
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
247
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
248
270
|
/** @public */
|
|
249
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
250
272
|
|
|
@@ -358,22 +380,6 @@ export declare interface BaseComponent<T> {
|
|
|
358
380
|
* If the value is undefined, the component was deleted.
|
|
359
381
|
*/
|
|
360
382
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
361
|
-
/**
|
|
362
|
-
* @public
|
|
363
|
-
*
|
|
364
|
-
*/
|
|
365
|
-
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
366
|
-
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
367
|
-
/**
|
|
368
|
-
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
369
|
-
* @param entity - Entity to get the CRDT state for
|
|
370
|
-
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
371
|
-
* @public
|
|
372
|
-
*/
|
|
373
|
-
getCrdtState(entity: Entity): {
|
|
374
|
-
data: Uint8Array;
|
|
375
|
-
timestamp: number;
|
|
376
|
-
} | null;
|
|
377
383
|
}
|
|
378
384
|
|
|
379
385
|
/** @public */
|
|
@@ -1373,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1373
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1374
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1375
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1376
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1377
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1378
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1380,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1380
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1381
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1382
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1383
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1384
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1385
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -1582,12 +1590,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1582
1590
|
/**
|
|
1583
1591
|
* @public
|
|
1584
1592
|
*/
|
|
1585
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1593
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1586
1594
|
|
|
1587
1595
|
/**
|
|
1588
1596
|
* @public
|
|
1589
1597
|
*/
|
|
1590
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1598
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1591
1599
|
|
|
1592
1600
|
/**
|
|
1593
1601
|
* Min length = 8 bytes
|
|
@@ -1642,8 +1650,7 @@ export declare enum CrdtMessageType {
|
|
|
1642
1650
|
PUT_COMPONENT_NETWORK = 5,
|
|
1643
1651
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1644
1652
|
DELETE_ENTITY_NETWORK = 7,
|
|
1645
|
-
|
|
1646
|
-
MAX_MESSAGE_TYPE = 9
|
|
1653
|
+
MAX_MESSAGE_TYPE = 8
|
|
1647
1654
|
}
|
|
1648
1655
|
|
|
1649
1656
|
/**
|
|
@@ -1651,8 +1658,6 @@ export declare enum CrdtMessageType {
|
|
|
1651
1658
|
*/
|
|
1652
1659
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1653
1660
|
|
|
1654
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1655
|
-
|
|
1656
1661
|
/**
|
|
1657
1662
|
* @public
|
|
1658
1663
|
*/
|
|
@@ -2087,6 +2092,7 @@ export declare type EventSystemOptions = {
|
|
|
2087
2092
|
showFeedback?: boolean;
|
|
2088
2093
|
showHighlight?: boolean;
|
|
2089
2094
|
maxPlayerDistance?: number;
|
|
2095
|
+
priority?: number;
|
|
2090
2096
|
};
|
|
2091
2097
|
|
|
2092
2098
|
/**
|
|
@@ -2345,12 +2351,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2345
2351
|
|
|
2346
2352
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2347
2353
|
|
|
2348
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2349
|
-
|
|
2350
|
-
export declare interface ICreatedByType {
|
|
2351
|
-
address: string;
|
|
2352
|
-
}
|
|
2353
|
-
|
|
2354
2354
|
/**
|
|
2355
2355
|
* @public
|
|
2356
2356
|
*/
|
|
@@ -2746,7 +2746,8 @@ export declare const enum InputAction {
|
|
|
2746
2746
|
IA_ACTION_3 = 10,
|
|
2747
2747
|
IA_ACTION_4 = 11,
|
|
2748
2748
|
IA_ACTION_5 = 12,
|
|
2749
|
-
IA_ACTION_6 = 13
|
|
2749
|
+
IA_ACTION_6 = 13,
|
|
2750
|
+
IA_MODIFIER = 14
|
|
2750
2751
|
}
|
|
2751
2752
|
|
|
2752
2753
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2795,32 +2796,11 @@ export declare type InstanceCompositeOptions = {
|
|
|
2795
2796
|
};
|
|
2796
2797
|
|
|
2797
2798
|
/**
|
|
2798
|
-
*
|
|
2799
|
-
* This is not exposed to users, only for internal SDK operations
|
|
2799
|
+
* @public
|
|
2800
2800
|
*/
|
|
2801
|
-
export declare
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2805
|
-
*/
|
|
2806
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2807
|
-
/**
|
|
2808
|
-
* @public
|
|
2809
|
-
* Get the iterator to every entity has the component
|
|
2810
|
-
*/
|
|
2811
|
-
iterator(): Iterable<[Entity, any]>;
|
|
2812
|
-
/**
|
|
2813
|
-
* @public
|
|
2814
|
-
*/
|
|
2815
|
-
dirtyIterator(): Iterable<Entity>;
|
|
2816
|
-
/**
|
|
2817
|
-
* @public
|
|
2818
|
-
*/
|
|
2819
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2820
|
-
/**
|
|
2821
|
-
* @public
|
|
2822
|
-
*/
|
|
2823
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2801
|
+
export declare const enum InteractionType {
|
|
2802
|
+
CURSOR = 0,
|
|
2803
|
+
PROXIMITY = 1
|
|
2824
2804
|
}
|
|
2825
2805
|
|
|
2826
2806
|
/**
|
|
@@ -4001,6 +3981,88 @@ export declare namespace MoveContinuous {
|
|
|
4001
3981
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4002
3982
|
}
|
|
4003
3983
|
|
|
3984
|
+
/**
|
|
3985
|
+
* @public
|
|
3986
|
+
*/
|
|
3987
|
+
export declare interface MoveRotateScale {
|
|
3988
|
+
positionStart: PBVector3 | undefined;
|
|
3989
|
+
positionEnd: PBVector3 | undefined;
|
|
3990
|
+
rotationStart: PBQuaternion | undefined;
|
|
3991
|
+
rotationEnd: PBQuaternion | undefined;
|
|
3992
|
+
scaleStart: PBVector3 | undefined;
|
|
3993
|
+
scaleEnd: PBVector3 | undefined;
|
|
3994
|
+
}
|
|
3995
|
+
|
|
3996
|
+
/**
|
|
3997
|
+
* @public
|
|
3998
|
+
*/
|
|
3999
|
+
export declare namespace MoveRotateScale {
|
|
4000
|
+
export function encode(message: MoveRotateScale, writer?: _m0.Writer): _m0.Writer;
|
|
4001
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScale;
|
|
4002
|
+
}
|
|
4003
|
+
|
|
4004
|
+
/**
|
|
4005
|
+
* @public
|
|
4006
|
+
*/
|
|
4007
|
+
export declare interface MoveRotateScaleContinuous {
|
|
4008
|
+
positionDirection: PBVector3 | undefined;
|
|
4009
|
+
rotationDirection: PBQuaternion | undefined;
|
|
4010
|
+
scaleDirection: PBVector3 | undefined;
|
|
4011
|
+
speed: number;
|
|
4012
|
+
}
|
|
4013
|
+
|
|
4014
|
+
/**
|
|
4015
|
+
* @public
|
|
4016
|
+
*/
|
|
4017
|
+
export declare namespace MoveRotateScaleContinuous {
|
|
4018
|
+
export function encode(message: MoveRotateScaleContinuous, writer?: _m0.Writer): _m0.Writer;
|
|
4019
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScaleContinuous;
|
|
4020
|
+
}
|
|
4021
|
+
|
|
4022
|
+
/**
|
|
4023
|
+
* @public
|
|
4024
|
+
* Partial params for Tween.Mode.MoveRotateScaleContinuous(). At least one of position, rotation, or scale must be provided.
|
|
4025
|
+
*/
|
|
4026
|
+
export declare interface MoveRotateScaleContinuousModeParams {
|
|
4027
|
+
/** Position direction for continuous movement. Optional. */
|
|
4028
|
+
position?: {
|
|
4029
|
+
direction: PBVector3;
|
|
4030
|
+
};
|
|
4031
|
+
/** Rotation direction for continuous rotation. Optional. */
|
|
4032
|
+
rotation?: {
|
|
4033
|
+
direction: PBQuaternion;
|
|
4034
|
+
};
|
|
4035
|
+
/** Scale direction for continuous scale change. Optional. */
|
|
4036
|
+
scale?: {
|
|
4037
|
+
direction: PBVector3;
|
|
4038
|
+
};
|
|
4039
|
+
/** Speed of the animation per second. */
|
|
4040
|
+
speed: number;
|
|
4041
|
+
}
|
|
4042
|
+
|
|
4043
|
+
/**
|
|
4044
|
+
* @public
|
|
4045
|
+
* Partial params for Tween.Mode.MoveRotateScale(). At least one of position, rotation, or scale must be provided.
|
|
4046
|
+
* Use this when building a mode for Tween.createOrReplace() or TweenSequence (e.g. only positionStart/positionEnd).
|
|
4047
|
+
*/
|
|
4048
|
+
export declare interface MoveRotateScaleModeParams {
|
|
4049
|
+
/** Position tween (start → end). Optional. */
|
|
4050
|
+
position?: {
|
|
4051
|
+
start: PBVector3;
|
|
4052
|
+
end: PBVector3;
|
|
4053
|
+
};
|
|
4054
|
+
/** Rotation tween (start → end). Optional. */
|
|
4055
|
+
rotation?: {
|
|
4056
|
+
start: PBQuaternion;
|
|
4057
|
+
end: PBQuaternion;
|
|
4058
|
+
};
|
|
4059
|
+
/** Scale tween (start → end). Optional. */
|
|
4060
|
+
scale?: {
|
|
4061
|
+
start: PBVector3;
|
|
4062
|
+
end: PBVector3;
|
|
4063
|
+
};
|
|
4064
|
+
}
|
|
4065
|
+
|
|
4004
4066
|
export declare const Name: NameComponent;
|
|
4005
4067
|
|
|
4006
4068
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4479,6 +4541,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4479
4541
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4480
4542
|
}
|
|
4481
4543
|
|
|
4544
|
+
/**
|
|
4545
|
+
* @public
|
|
4546
|
+
*/
|
|
4547
|
+
export declare interface PBAudioAnalysis {
|
|
4548
|
+
/** Parameters section */
|
|
4549
|
+
mode: PBAudioAnalysisMode;
|
|
4550
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4551
|
+
amplitudeGain?: number | undefined;
|
|
4552
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4553
|
+
bandsGain?: number | undefined;
|
|
4554
|
+
/** Result section */
|
|
4555
|
+
amplitude: number;
|
|
4556
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4557
|
+
band0: number;
|
|
4558
|
+
band1: number;
|
|
4559
|
+
band2: number;
|
|
4560
|
+
band3: number;
|
|
4561
|
+
band4: number;
|
|
4562
|
+
band5: number;
|
|
4563
|
+
band6: number;
|
|
4564
|
+
band7: number;
|
|
4565
|
+
}
|
|
4566
|
+
|
|
4567
|
+
/**
|
|
4568
|
+
* @public
|
|
4569
|
+
*/
|
|
4570
|
+
export declare namespace PBAudioAnalysis {
|
|
4571
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4572
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4573
|
+
}
|
|
4574
|
+
|
|
4575
|
+
/**
|
|
4576
|
+
* @public
|
|
4577
|
+
*/
|
|
4578
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4579
|
+
MODE_RAW = 0,
|
|
4580
|
+
MODE_LOGARITHMIC = 1
|
|
4581
|
+
}
|
|
4582
|
+
|
|
4482
4583
|
/**
|
|
4483
4584
|
* @public
|
|
4484
4585
|
*/
|
|
@@ -4668,6 +4769,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4668
4769
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4669
4770
|
}
|
|
4670
4771
|
|
|
4772
|
+
/**
|
|
4773
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4774
|
+
* as the avatar movement speed, jump height etc.
|
|
4775
|
+
*/
|
|
4776
|
+
/**
|
|
4777
|
+
* @public
|
|
4778
|
+
*/
|
|
4779
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4780
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4781
|
+
walkSpeed?: number | undefined;
|
|
4782
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4783
|
+
jogSpeed?: number | undefined;
|
|
4784
|
+
/** Maximum speed when running (in meters per second) */
|
|
4785
|
+
runSpeed?: number | undefined;
|
|
4786
|
+
/** Height of a regular jump (in meters) */
|
|
4787
|
+
jumpHeight?: number | undefined;
|
|
4788
|
+
/** Height of a jump while running (in meters) */
|
|
4789
|
+
runJumpHeight?: number | undefined;
|
|
4790
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4791
|
+
hardLandingCooldown?: number | undefined;
|
|
4792
|
+
}
|
|
4793
|
+
|
|
4794
|
+
/**
|
|
4795
|
+
* @public
|
|
4796
|
+
*/
|
|
4797
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4798
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4799
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4800
|
+
}
|
|
4801
|
+
|
|
4671
4802
|
/**
|
|
4672
4803
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4673
4804
|
* avatar behavior changes.
|
|
@@ -5520,6 +5651,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5520
5651
|
eventType: PointerEventType;
|
|
5521
5652
|
/** additional configuration for this detection */
|
|
5522
5653
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5654
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5655
|
+
interactionType?: InteractionType | undefined;
|
|
5523
5656
|
}
|
|
5524
5657
|
|
|
5525
5658
|
/**
|
|
@@ -5546,6 +5679,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5546
5679
|
showHighlight?: boolean | undefined;
|
|
5547
5680
|
/** range of interaction from the avatar's position (default 0) */
|
|
5548
5681
|
maxPlayerDistance?: number | undefined;
|
|
5682
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5683
|
+
priority?: number | undefined;
|
|
5549
5684
|
}
|
|
5550
5685
|
|
|
5551
5686
|
/**
|
|
@@ -5982,6 +6117,12 @@ export declare interface PBTween {
|
|
|
5982
6117
|
} | {
|
|
5983
6118
|
$case: "textureMoveContinuous";
|
|
5984
6119
|
textureMoveContinuous: TextureMoveContinuous;
|
|
6120
|
+
} | {
|
|
6121
|
+
$case: "moveRotateScale";
|
|
6122
|
+
moveRotateScale: MoveRotateScale;
|
|
6123
|
+
} | {
|
|
6124
|
+
$case: "moveRotateScaleContinuous";
|
|
6125
|
+
moveRotateScaleContinuous: MoveRotateScaleContinuous;
|
|
5985
6126
|
} | undefined;
|
|
5986
6127
|
/** default true (pause or running) */
|
|
5987
6128
|
playing?: boolean | undefined;
|
|
@@ -6419,6 +6560,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6419
6560
|
* an 'instant' transition (like using speed/time = 0)
|
|
6420
6561
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6421
6562
|
* the holding entity transform).
|
|
6563
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6422
6564
|
*/
|
|
6423
6565
|
/**
|
|
6424
6566
|
* @public
|
|
@@ -6426,6 +6568,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6426
6568
|
export declare interface PBVirtualCamera {
|
|
6427
6569
|
defaultTransition?: CameraTransition | undefined;
|
|
6428
6570
|
lookAtEntity?: number | undefined;
|
|
6571
|
+
/** default: 60 */
|
|
6572
|
+
fov?: number | undefined;
|
|
6429
6573
|
}
|
|
6430
6574
|
|
|
6431
6575
|
/**
|
|
@@ -6615,6 +6759,30 @@ export declare interface PointerEventsSystem {
|
|
|
6615
6759
|
* @param entity - Entity where the callback was attached
|
|
6616
6760
|
*/
|
|
6617
6761
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6762
|
+
/**
|
|
6763
|
+
* @public
|
|
6764
|
+
* Remove the callback for onProximityDown event
|
|
6765
|
+
* @param entity - Entity where the callback was attached
|
|
6766
|
+
*/
|
|
6767
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6768
|
+
/**
|
|
6769
|
+
* @public
|
|
6770
|
+
* Remove the callback for onProximityUp event
|
|
6771
|
+
* @param entity - Entity where the callback was attached
|
|
6772
|
+
*/
|
|
6773
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6774
|
+
/**
|
|
6775
|
+
* @public
|
|
6776
|
+
* Remove the callback for onProximityEnter event
|
|
6777
|
+
* @param entity - Entity where the callback was attached
|
|
6778
|
+
*/
|
|
6779
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6780
|
+
/**
|
|
6781
|
+
* @public
|
|
6782
|
+
* Remove the callback for onProximityLeave event
|
|
6783
|
+
* @param entity - Entity where the callback was attached
|
|
6784
|
+
*/
|
|
6785
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6618
6786
|
/**
|
|
6619
6787
|
* @public
|
|
6620
6788
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6669,6 +6837,46 @@ export declare interface PointerEventsSystem {
|
|
|
6669
6837
|
entity: Entity;
|
|
6670
6838
|
opts?: Partial<EventSystemOptions>;
|
|
6671
6839
|
}, cb: EventSystemCallback): void;
|
|
6840
|
+
/**
|
|
6841
|
+
* @public
|
|
6842
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6843
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6844
|
+
* @param cb - Function to execute when click fires
|
|
6845
|
+
*/
|
|
6846
|
+
onProximityDown(pointerData: {
|
|
6847
|
+
entity: Entity;
|
|
6848
|
+
opts?: Partial<EventSystemOptions>;
|
|
6849
|
+
}, cb: EventSystemCallback): void;
|
|
6850
|
+
/**
|
|
6851
|
+
* @public
|
|
6852
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6853
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6854
|
+
* @param cb - Function to execute when event fires
|
|
6855
|
+
*/
|
|
6856
|
+
onProximityUp(pointerData: {
|
|
6857
|
+
entity: Entity;
|
|
6858
|
+
opts?: Partial<EventSystemOptions>;
|
|
6859
|
+
}, cb: EventSystemCallback): void;
|
|
6860
|
+
/**
|
|
6861
|
+
* @public
|
|
6862
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6863
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6864
|
+
* @param cb - Function to execute when event fires
|
|
6865
|
+
*/
|
|
6866
|
+
onProximityEnter(pointerData: {
|
|
6867
|
+
entity: Entity;
|
|
6868
|
+
opts?: Partial<EventSystemOptions>;
|
|
6869
|
+
}, cb: EventSystemCallback): void;
|
|
6870
|
+
/**
|
|
6871
|
+
* @public
|
|
6872
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6873
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6874
|
+
* @param cb - Function to execute when event fires
|
|
6875
|
+
*/
|
|
6876
|
+
onProximityLeave(pointerData: {
|
|
6877
|
+
entity: Entity;
|
|
6878
|
+
opts?: Partial<EventSystemOptions>;
|
|
6879
|
+
}, cb: EventSystemCallback): void;
|
|
6672
6880
|
}
|
|
6673
6881
|
|
|
6674
6882
|
/**
|
|
@@ -6685,7 +6893,9 @@ export declare const enum PointerEventType {
|
|
|
6685
6893
|
PET_UP = 0,
|
|
6686
6894
|
PET_DOWN = 1,
|
|
6687
6895
|
PET_HOVER_ENTER = 2,
|
|
6688
|
-
PET_HOVER_LEAVE = 3
|
|
6896
|
+
PET_HOVER_LEAVE = 3,
|
|
6897
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6898
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6689
6899
|
}
|
|
6690
6900
|
|
|
6691
6901
|
/**
|
|
@@ -7902,6 +8112,26 @@ export declare namespace Schemas {
|
|
|
7902
8112
|
}) => void;
|
|
7903
8113
|
}
|
|
7904
8114
|
|
|
8115
|
+
/**
|
|
8116
|
+
* @public
|
|
8117
|
+
* Parameters for setMoveRotateScaleContinuous. At least one of position, rotation, or scale must be provided.
|
|
8118
|
+
*/
|
|
8119
|
+
export declare interface SetMoveRotateScaleContinuousParams extends MoveRotateScaleContinuousModeParams {
|
|
8120
|
+
/** Duration in milliseconds (defaults to 0 for infinite). */
|
|
8121
|
+
duration?: number;
|
|
8122
|
+
}
|
|
8123
|
+
|
|
8124
|
+
/**
|
|
8125
|
+
* @public
|
|
8126
|
+
* Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
|
|
8127
|
+
*/
|
|
8128
|
+
export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModeParams {
|
|
8129
|
+
/** Duration of the tween in milliseconds. */
|
|
8130
|
+
duration: number;
|
|
8131
|
+
/** Easing function (defaults to EF_LINEAR). */
|
|
8132
|
+
easingFunction?: EasingFunction;
|
|
8133
|
+
}
|
|
8134
|
+
|
|
7905
8135
|
/** @public */
|
|
7906
8136
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7907
8137
|
|
|
@@ -8503,6 +8733,26 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8503
8733
|
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8504
8734
|
*/
|
|
8505
8735
|
setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
|
|
8736
|
+
/**
|
|
8737
|
+
* @public
|
|
8738
|
+
*
|
|
8739
|
+
* Creates or replaces a move-rotate-scale tween component that simultaneously animates
|
|
8740
|
+
* an entity's position, rotation, and/or scale from start to end. Provide only the
|
|
8741
|
+
* properties you need (at least one of position, rotation, or scale).
|
|
8742
|
+
* @param entity - entity to apply the tween to
|
|
8743
|
+
* @param params - object with optional position, rotation, scale (each with start/end), duration, and optional easingFunction
|
|
8744
|
+
*/
|
|
8745
|
+
setMoveRotateScale(entity: Entity, params: SetMoveRotateScaleParams): void;
|
|
8746
|
+
/**
|
|
8747
|
+
* @public
|
|
8748
|
+
*
|
|
8749
|
+
* Creates or replaces a continuous move-rotate-scale tween component that simultaneously
|
|
8750
|
+
* moves, rotates, and/or scales an entity continuously. Provide only the properties
|
|
8751
|
+
* you need (at least one of position, rotation, or scale).
|
|
8752
|
+
* @param entity - entity to apply the tween to
|
|
8753
|
+
* @param params - object with optional position, rotation, scale (each with direction), speed, and optional duration
|
|
8754
|
+
*/
|
|
8755
|
+
setMoveRotateScaleContinuous(entity: Entity, params: SetMoveRotateScaleContinuousParams): void;
|
|
8506
8756
|
}
|
|
8507
8757
|
|
|
8508
8758
|
/**
|
|
@@ -8537,6 +8787,16 @@ export declare interface TweenHelper {
|
|
|
8537
8787
|
* @returns a texture-move-continuous mode tween
|
|
8538
8788
|
*/
|
|
8539
8789
|
TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
|
|
8790
|
+
/**
|
|
8791
|
+
* @returns a move-rotate-scale mode tween
|
|
8792
|
+
* @param params - partial transform (at least one of position, rotation, scale); omit axes you don't need
|
|
8793
|
+
*/
|
|
8794
|
+
MoveRotateScale: (params: MoveRotateScaleModeParams) => PBTween['mode'];
|
|
8795
|
+
/**
|
|
8796
|
+
* @returns a move-rotate-scale-continuous mode tween
|
|
8797
|
+
* @param params - partial transform (at least one of position, rotation, scale) + speed; omit axes you don't need
|
|
8798
|
+
*/
|
|
8799
|
+
MoveRotateScaleContinuous: (params: MoveRotateScaleContinuousModeParams) => PBTween['mode'];
|
|
8540
8800
|
}
|
|
8541
8801
|
|
|
8542
8802
|
/**
|
|
@@ -8794,14 +9054,6 @@ export declare interface UiTransformProps {
|
|
|
8794
9054
|
*/
|
|
8795
9055
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
8796
9056
|
|
|
8797
|
-
export declare type ValidateCallback<T> = (value: {
|
|
8798
|
-
entity: Entity;
|
|
8799
|
-
currentValue: T | undefined;
|
|
8800
|
-
newValue: T | undefined;
|
|
8801
|
-
senderAddress: string;
|
|
8802
|
-
createdBy: string;
|
|
8803
|
-
}) => boolean;
|
|
8804
|
-
|
|
8805
9057
|
/**
|
|
8806
9058
|
* @public
|
|
8807
9059
|
*/
|