@dcl/playground-assets 7.20.5-22631826546.commit-7c189f5 → 7.20.5-22638270380.commit-3f48d5e
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 +99 -420
- package/dist/beta.d.ts +99 -420
- package/dist/index.bundled.d.ts +99 -420
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground/snippets/pointer-events.ts +7 -14
- package/dist/playground-assets.d.ts +99 -420
- package/etc/playground-assets.api.json +2462 -5630
- package/etc/playground-assets.api.md +75 -264
- package/package.json +6 -5
package/dist/alpha.d.ts
CHANGED
|
@@ -115,61 +115,6 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
-
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
-
|
|
120
|
-
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
-
/**
|
|
122
|
-
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
-
*
|
|
124
|
-
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
-
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
-
*/
|
|
128
|
-
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
-
/**
|
|
130
|
-
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
-
*
|
|
132
|
-
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
-
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
-
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
-
*/
|
|
137
|
-
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
-
/**
|
|
139
|
-
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
-
*
|
|
141
|
-
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
-
*
|
|
143
|
-
* @param entity - The entity to attach the component to.
|
|
144
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
-
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
-
*/
|
|
148
|
-
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
-
/**
|
|
151
|
-
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
-
*
|
|
153
|
-
* @param entity - The target entity.
|
|
154
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
-
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
-
*/
|
|
158
|
-
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
-
*
|
|
165
|
-
* `amplitude` represents the aggregated signal strength.
|
|
166
|
-
* `bands` represents the processed frequency bands.
|
|
167
|
-
*/
|
|
168
|
-
export declare type AudioAnalysisView = {
|
|
169
|
-
amplitude: number;
|
|
170
|
-
bands: number[];
|
|
171
|
-
};
|
|
172
|
-
|
|
173
118
|
/** @public */
|
|
174
119
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
175
120
|
|
|
@@ -218,6 +163,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
218
163
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
219
164
|
}
|
|
220
165
|
|
|
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
|
+
|
|
221
202
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
222
203
|
/**
|
|
223
204
|
* @public
|
|
@@ -264,9 +245,6 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
264
245
|
/** @public */
|
|
265
246
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
266
247
|
|
|
267
|
-
/** @public */
|
|
268
|
-
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
-
|
|
270
248
|
/** @public */
|
|
271
249
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
272
250
|
|
|
@@ -380,6 +358,22 @@ export declare interface BaseComponent<T> {
|
|
|
380
358
|
* If the value is undefined, the component was deleted.
|
|
381
359
|
*/
|
|
382
360
|
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;
|
|
383
377
|
}
|
|
384
378
|
|
|
385
379
|
/** @public */
|
|
@@ -1379,7 +1373,6 @@ export declare const componentDefinitionByName: {
|
|
|
1379
1373
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1380
1374
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1381
1375
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
-
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1383
1376
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1384
1377
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1385
1378
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1387,7 +1380,6 @@ export declare const componentDefinitionByName: {
|
|
|
1387
1380
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1388
1381
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1389
1382
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
-
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1391
1383
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1392
1384
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1393
1385
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -1404,8 +1396,6 @@ export declare const componentDefinitionByName: {
|
|
|
1404
1396
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
|
1405
1397
|
"core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
|
|
1406
1398
|
"core::NftShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBNftShape>>;
|
|
1407
|
-
"core::PhysicsCombinedForce": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>>;
|
|
1408
|
-
"core::PhysicsCombinedImpulse": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>>;
|
|
1409
1399
|
"core::PlayerIdentityData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPlayerIdentityData>>;
|
|
1410
1400
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
|
1411
1401
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
|
@@ -1592,12 +1582,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1592
1582
|
/**
|
|
1593
1583
|
* @public
|
|
1594
1584
|
*/
|
|
1595
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1585
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1596
1586
|
|
|
1597
1587
|
/**
|
|
1598
1588
|
* @public
|
|
1599
1589
|
*/
|
|
1600
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1590
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1601
1591
|
|
|
1602
1592
|
/**
|
|
1603
1593
|
* Min length = 8 bytes
|
|
@@ -1652,7 +1642,8 @@ export declare enum CrdtMessageType {
|
|
|
1652
1642
|
PUT_COMPONENT_NETWORK = 5,
|
|
1653
1643
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1654
1644
|
DELETE_ENTITY_NETWORK = 7,
|
|
1655
|
-
|
|
1645
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1646
|
+
MAX_MESSAGE_TYPE = 9
|
|
1656
1647
|
}
|
|
1657
1648
|
|
|
1658
1649
|
/**
|
|
@@ -1660,6 +1651,8 @@ export declare enum CrdtMessageType {
|
|
|
1660
1651
|
*/
|
|
1661
1652
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1662
1653
|
|
|
1654
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1655
|
+
|
|
1663
1656
|
/**
|
|
1664
1657
|
* @public
|
|
1665
1658
|
*/
|
|
@@ -2094,7 +2087,6 @@ export declare type EventSystemOptions = {
|
|
|
2094
2087
|
showFeedback?: boolean;
|
|
2095
2088
|
showHighlight?: boolean;
|
|
2096
2089
|
maxPlayerDistance?: number;
|
|
2097
|
-
priority?: number;
|
|
2098
2090
|
};
|
|
2099
2091
|
|
|
2100
2092
|
/**
|
|
@@ -2353,6 +2345,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2353
2345
|
|
|
2354
2346
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2355
2347
|
|
|
2348
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2349
|
+
|
|
2350
|
+
export declare interface ICreatedByType {
|
|
2351
|
+
address: string;
|
|
2352
|
+
}
|
|
2353
|
+
|
|
2356
2354
|
/**
|
|
2357
2355
|
* @public
|
|
2358
2356
|
*/
|
|
@@ -2748,8 +2746,7 @@ export declare const enum InputAction {
|
|
|
2748
2746
|
IA_ACTION_3 = 10,
|
|
2749
2747
|
IA_ACTION_4 = 11,
|
|
2750
2748
|
IA_ACTION_5 = 12,
|
|
2751
|
-
IA_ACTION_6 = 13
|
|
2752
|
-
IA_MODIFIER = 14
|
|
2749
|
+
IA_ACTION_6 = 13
|
|
2753
2750
|
}
|
|
2754
2751
|
|
|
2755
2752
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2798,11 +2795,32 @@ export declare type InstanceCompositeOptions = {
|
|
|
2798
2795
|
};
|
|
2799
2796
|
|
|
2800
2797
|
/**
|
|
2801
|
-
*
|
|
2798
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
2799
|
+
* This is not exposed to users, only for internal SDK operations
|
|
2802
2800
|
*/
|
|
2803
|
-
export declare
|
|
2804
|
-
|
|
2805
|
-
|
|
2801
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2802
|
+
/**
|
|
2803
|
+
* @public
|
|
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;
|
|
2806
2824
|
}
|
|
2807
2825
|
|
|
2808
2826
|
/**
|
|
@@ -3983,88 +4001,6 @@ export declare namespace MoveContinuous {
|
|
|
3983
4001
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3984
4002
|
}
|
|
3985
4003
|
|
|
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
|
-
|
|
4068
4004
|
export declare const Name: NameComponent;
|
|
4069
4005
|
|
|
4070
4006
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4543,45 +4479,6 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4543
4479
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4544
4480
|
}
|
|
4545
4481
|
|
|
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
|
-
|
|
4585
4482
|
/**
|
|
4586
4483
|
* @public
|
|
4587
4484
|
*/
|
|
@@ -4771,42 +4668,6 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4771
4668
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4772
4669
|
}
|
|
4773
4670
|
|
|
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
|
-
|
|
4810
4671
|
/**
|
|
4811
4672
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4812
4673
|
* avatar behavior changes.
|
|
@@ -5154,8 +5015,6 @@ export declare interface PBInputModifier_StandardInput {
|
|
|
5154
5015
|
disableRun?: boolean | undefined;
|
|
5155
5016
|
disableJump?: boolean | undefined;
|
|
5156
5017
|
disableEmote?: boolean | undefined;
|
|
5157
|
-
disableDoubleJump?: boolean | undefined;
|
|
5158
|
-
disableGliding?: boolean | undefined;
|
|
5159
5018
|
}
|
|
5160
5019
|
|
|
5161
5020
|
/**
|
|
@@ -5577,59 +5436,6 @@ export declare namespace PBNftShape {
|
|
|
5577
5436
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
|
|
5578
5437
|
}
|
|
5579
5438
|
|
|
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
|
-
|
|
5633
5439
|
/**
|
|
5634
5440
|
* PlayerIdentityData is used to read the information about the avatar's
|
|
5635
5441
|
* identity. this component is written by the engine using the communications
|
|
@@ -5714,8 +5520,6 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5714
5520
|
eventType: PointerEventType;
|
|
5715
5521
|
/** additional configuration for this detection */
|
|
5716
5522
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5717
|
-
/** the type of interaction source (default 0 == CURSOR) */
|
|
5718
|
-
interactionType?: InteractionType | undefined;
|
|
5719
5523
|
}
|
|
5720
5524
|
|
|
5721
5525
|
/**
|
|
@@ -5742,8 +5546,6 @@ export declare interface PBPointerEvents_Info {
|
|
|
5742
5546
|
showHighlight?: boolean | undefined;
|
|
5743
5547
|
/** range of interaction from the avatar's position (default 0) */
|
|
5744
5548
|
maxPlayerDistance?: number | undefined;
|
|
5745
|
-
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5746
|
-
priority?: number | undefined;
|
|
5747
5549
|
}
|
|
5748
5550
|
|
|
5749
5551
|
/**
|
|
@@ -6180,12 +5982,6 @@ export declare interface PBTween {
|
|
|
6180
5982
|
} | {
|
|
6181
5983
|
$case: "textureMoveContinuous";
|
|
6182
5984
|
textureMoveContinuous: TextureMoveContinuous;
|
|
6183
|
-
} | {
|
|
6184
|
-
$case: "moveRotateScale";
|
|
6185
|
-
moveRotateScale: MoveRotateScale;
|
|
6186
|
-
} | {
|
|
6187
|
-
$case: "moveRotateScaleContinuous";
|
|
6188
|
-
moveRotateScaleContinuous: MoveRotateScaleContinuous;
|
|
6189
5985
|
} | undefined;
|
|
6190
5986
|
/** default true (pause or running) */
|
|
6191
5987
|
playing?: boolean | undefined;
|
|
@@ -6623,7 +6419,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6623
6419
|
* an 'instant' transition (like using speed/time = 0)
|
|
6624
6420
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6625
6421
|
* the holding entity transform).
|
|
6626
|
-
* * The fov defines the Field of View of the virtual camera
|
|
6627
6422
|
*/
|
|
6628
6423
|
/**
|
|
6629
6424
|
* @public
|
|
@@ -6631,8 +6426,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6631
6426
|
export declare interface PBVirtualCamera {
|
|
6632
6427
|
defaultTransition?: CameraTransition | undefined;
|
|
6633
6428
|
lookAtEntity?: number | undefined;
|
|
6634
|
-
/** default: 60 */
|
|
6635
|
-
fov?: number | undefined;
|
|
6636
6429
|
}
|
|
6637
6430
|
|
|
6638
6431
|
/**
|
|
@@ -6667,12 +6460,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
6667
6460
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6668
6461
|
}
|
|
6669
6462
|
|
|
6670
|
-
/** @public */
|
|
6671
|
-
export declare const PhysicsCombinedForce: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>;
|
|
6672
|
-
|
|
6673
|
-
/** @public */
|
|
6674
|
-
export declare const PhysicsCombinedImpulse: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>;
|
|
6675
|
-
|
|
6676
6463
|
/**
|
|
6677
6464
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6678
6465
|
* @public
|
|
@@ -6828,30 +6615,6 @@ export declare interface PointerEventsSystem {
|
|
|
6828
6615
|
* @param entity - Entity where the callback was attached
|
|
6829
6616
|
*/
|
|
6830
6617
|
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;
|
|
6855
6618
|
/**
|
|
6856
6619
|
* @public
|
|
6857
6620
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6906,46 +6669,6 @@ export declare interface PointerEventsSystem {
|
|
|
6906
6669
|
entity: Entity;
|
|
6907
6670
|
opts?: Partial<EventSystemOptions>;
|
|
6908
6671
|
}, 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;
|
|
6949
6672
|
}
|
|
6950
6673
|
|
|
6951
6674
|
/**
|
|
@@ -6962,9 +6685,7 @@ export declare const enum PointerEventType {
|
|
|
6962
6685
|
PET_UP = 0,
|
|
6963
6686
|
PET_DOWN = 1,
|
|
6964
6687
|
PET_HOVER_ENTER = 2,
|
|
6965
|
-
PET_HOVER_LEAVE = 3
|
|
6966
|
-
PET_PROXIMITY_ENTER = 4,
|
|
6967
|
-
PET_PROXIMITY_LEAVE = 5
|
|
6688
|
+
PET_HOVER_LEAVE = 3
|
|
6968
6689
|
}
|
|
6969
6690
|
|
|
6970
6691
|
/**
|
|
@@ -8181,26 +7902,6 @@ export declare namespace Schemas {
|
|
|
8181
7902
|
}) => void;
|
|
8182
7903
|
}
|
|
8183
7904
|
|
|
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
|
-
|
|
8204
7905
|
/** @public */
|
|
8205
7906
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
8206
7907
|
|
|
@@ -8802,26 +8503,6 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8802
8503
|
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8803
8504
|
*/
|
|
8804
8505
|
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;
|
|
8825
8506
|
}
|
|
8826
8507
|
|
|
8827
8508
|
/**
|
|
@@ -8856,16 +8537,6 @@ export declare interface TweenHelper {
|
|
|
8856
8537
|
* @returns a texture-move-continuous mode tween
|
|
8857
8538
|
*/
|
|
8858
8539
|
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'];
|
|
8869
8540
|
}
|
|
8870
8541
|
|
|
8871
8542
|
/**
|
|
@@ -9123,6 +8794,14 @@ export declare interface UiTransformProps {
|
|
|
9123
8794
|
*/
|
|
9124
8795
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9125
8796
|
|
|
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
|
+
|
|
9126
8805
|
/**
|
|
9127
8806
|
* @public
|
|
9128
8807
|
*/
|