@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/beta.d.ts
CHANGED
|
@@ -115,61 +115,6 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
-
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
-
|
|
120
|
-
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
-
/**
|
|
122
|
-
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
-
*
|
|
124
|
-
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
-
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
-
*/
|
|
128
|
-
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
-
/**
|
|
130
|
-
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
-
*
|
|
132
|
-
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
-
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
-
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
-
*/
|
|
137
|
-
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
-
/**
|
|
139
|
-
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
-
*
|
|
141
|
-
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
-
*
|
|
143
|
-
* @param entity - The entity to attach the component to.
|
|
144
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
-
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
-
*/
|
|
148
|
-
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
-
/**
|
|
151
|
-
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
-
*
|
|
153
|
-
* @param entity - The target entity.
|
|
154
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
-
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
-
*/
|
|
158
|
-
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
-
*
|
|
165
|
-
* `amplitude` represents the aggregated signal strength.
|
|
166
|
-
* `bands` represents the processed frequency bands.
|
|
167
|
-
*/
|
|
168
|
-
export declare type AudioAnalysisView = {
|
|
169
|
-
amplitude: number;
|
|
170
|
-
bands: number[];
|
|
171
|
-
};
|
|
172
|
-
|
|
173
118
|
/** @public */
|
|
174
119
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
175
120
|
|
|
@@ -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
|
*/
|
|
@@ -2739,8 +2737,7 @@ export declare const enum InputAction {
|
|
|
2739
2737
|
IA_ACTION_3 = 10,
|
|
2740
2738
|
IA_ACTION_4 = 11,
|
|
2741
2739
|
IA_ACTION_5 = 12,
|
|
2742
|
-
IA_ACTION_6 = 13
|
|
2743
|
-
IA_MODIFIER = 14
|
|
2740
|
+
IA_ACTION_6 = 13
|
|
2744
2741
|
}
|
|
2745
2742
|
|
|
2746
2743
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2789,11 +2786,32 @@ export declare type InstanceCompositeOptions = {
|
|
|
2789
2786
|
};
|
|
2790
2787
|
|
|
2791
2788
|
/**
|
|
2792
|
-
*
|
|
2789
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
2790
|
+
* This is not exposed to users, only for internal SDK operations
|
|
2793
2791
|
*/
|
|
2794
|
-
export declare
|
|
2795
|
-
|
|
2796
|
-
|
|
2792
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2793
|
+
/**
|
|
2794
|
+
* @public
|
|
2795
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2796
|
+
*/
|
|
2797
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2798
|
+
/**
|
|
2799
|
+
* @public
|
|
2800
|
+
* Get the iterator to every entity has the component
|
|
2801
|
+
*/
|
|
2802
|
+
iterator(): Iterable<[Entity, any]>;
|
|
2803
|
+
/**
|
|
2804
|
+
* @public
|
|
2805
|
+
*/
|
|
2806
|
+
dirtyIterator(): Iterable<Entity>;
|
|
2807
|
+
/**
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2810
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2811
|
+
/**
|
|
2812
|
+
* @public
|
|
2813
|
+
*/
|
|
2814
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2797
2815
|
}
|
|
2798
2816
|
|
|
2799
2817
|
/**
|
|
@@ -3963,88 +3981,6 @@ export declare namespace MoveContinuous {
|
|
|
3963
3981
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3964
3982
|
}
|
|
3965
3983
|
|
|
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
|
-
|
|
4048
3984
|
export declare const Name: NameComponent;
|
|
4049
3985
|
|
|
4050
3986
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4515,45 +4451,6 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4515
4451
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4516
4452
|
}
|
|
4517
4453
|
|
|
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
|
-
|
|
4557
4454
|
/**
|
|
4558
4455
|
* @public
|
|
4559
4456
|
*/
|
|
@@ -4743,42 +4640,6 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4743
4640
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4744
4641
|
}
|
|
4745
4642
|
|
|
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
|
-
|
|
4782
4643
|
/**
|
|
4783
4644
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4784
4645
|
* avatar behavior changes.
|
|
@@ -5126,8 +4987,6 @@ export declare interface PBInputModifier_StandardInput {
|
|
|
5126
4987
|
disableRun?: boolean | undefined;
|
|
5127
4988
|
disableJump?: boolean | undefined;
|
|
5128
4989
|
disableEmote?: boolean | undefined;
|
|
5129
|
-
disableDoubleJump?: boolean | undefined;
|
|
5130
|
-
disableGliding?: boolean | undefined;
|
|
5131
4990
|
}
|
|
5132
4991
|
|
|
5133
4992
|
/**
|
|
@@ -5549,59 +5408,6 @@ export declare namespace PBNftShape {
|
|
|
5549
5408
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
|
|
5550
5409
|
}
|
|
5551
5410
|
|
|
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
|
-
|
|
5605
5411
|
/**
|
|
5606
5412
|
* PlayerIdentityData is used to read the information about the avatar's
|
|
5607
5413
|
* identity. this component is written by the engine using the communications
|
|
@@ -5686,8 +5492,6 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5686
5492
|
eventType: PointerEventType;
|
|
5687
5493
|
/** additional configuration for this detection */
|
|
5688
5494
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5689
|
-
/** the type of interaction source (default 0 == CURSOR) */
|
|
5690
|
-
interactionType?: InteractionType | undefined;
|
|
5691
5495
|
}
|
|
5692
5496
|
|
|
5693
5497
|
/**
|
|
@@ -5714,8 +5518,6 @@ export declare interface PBPointerEvents_Info {
|
|
|
5714
5518
|
showHighlight?: boolean | undefined;
|
|
5715
5519
|
/** range of interaction from the avatar's position (default 0) */
|
|
5716
5520
|
maxPlayerDistance?: number | undefined;
|
|
5717
|
-
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5718
|
-
priority?: number | undefined;
|
|
5719
5521
|
}
|
|
5720
5522
|
|
|
5721
5523
|
/**
|
|
@@ -6152,12 +5954,6 @@ export declare interface PBTween {
|
|
|
6152
5954
|
} | {
|
|
6153
5955
|
$case: "textureMoveContinuous";
|
|
6154
5956
|
textureMoveContinuous: TextureMoveContinuous;
|
|
6155
|
-
} | {
|
|
6156
|
-
$case: "moveRotateScale";
|
|
6157
|
-
moveRotateScale: MoveRotateScale;
|
|
6158
|
-
} | {
|
|
6159
|
-
$case: "moveRotateScaleContinuous";
|
|
6160
|
-
moveRotateScaleContinuous: MoveRotateScaleContinuous;
|
|
6161
5957
|
} | undefined;
|
|
6162
5958
|
/** default true (pause or running) */
|
|
6163
5959
|
playing?: boolean | undefined;
|
|
@@ -6595,7 +6391,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6595
6391
|
* an 'instant' transition (like using speed/time = 0)
|
|
6596
6392
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6597
6393
|
* the holding entity transform).
|
|
6598
|
-
* * The fov defines the Field of View of the virtual camera
|
|
6599
6394
|
*/
|
|
6600
6395
|
/**
|
|
6601
6396
|
* @public
|
|
@@ -6603,8 +6398,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6603
6398
|
export declare interface PBVirtualCamera {
|
|
6604
6399
|
defaultTransition?: CameraTransition | undefined;
|
|
6605
6400
|
lookAtEntity?: number | undefined;
|
|
6606
|
-
/** default: 60 */
|
|
6607
|
-
fov?: number | undefined;
|
|
6608
6401
|
}
|
|
6609
6402
|
|
|
6610
6403
|
/**
|
|
@@ -6639,12 +6432,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
6639
6432
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6640
6433
|
}
|
|
6641
6434
|
|
|
6642
|
-
/** @public */
|
|
6643
|
-
export declare const PhysicsCombinedForce: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>;
|
|
6644
|
-
|
|
6645
|
-
/** @public */
|
|
6646
|
-
export declare const PhysicsCombinedImpulse: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>;
|
|
6647
|
-
|
|
6648
6435
|
/**
|
|
6649
6436
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6650
6437
|
* @public
|
|
@@ -6800,30 +6587,6 @@ export declare interface PointerEventsSystem {
|
|
|
6800
6587
|
* @param entity - Entity where the callback was attached
|
|
6801
6588
|
*/
|
|
6802
6589
|
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;
|
|
6827
6590
|
/**
|
|
6828
6591
|
* @public
|
|
6829
6592
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6878,46 +6641,6 @@ export declare interface PointerEventsSystem {
|
|
|
6878
6641
|
entity: Entity;
|
|
6879
6642
|
opts?: Partial<EventSystemOptions>;
|
|
6880
6643
|
}, 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;
|
|
6921
6644
|
}
|
|
6922
6645
|
|
|
6923
6646
|
/**
|
|
@@ -6934,9 +6657,7 @@ export declare const enum PointerEventType {
|
|
|
6934
6657
|
PET_UP = 0,
|
|
6935
6658
|
PET_DOWN = 1,
|
|
6936
6659
|
PET_HOVER_ENTER = 2,
|
|
6937
|
-
PET_HOVER_LEAVE = 3
|
|
6938
|
-
PET_PROXIMITY_ENTER = 4,
|
|
6939
|
-
PET_PROXIMITY_LEAVE = 5
|
|
6660
|
+
PET_HOVER_LEAVE = 3
|
|
6940
6661
|
}
|
|
6941
6662
|
|
|
6942
6663
|
/**
|
|
@@ -8153,26 +7874,6 @@ export declare namespace Schemas {
|
|
|
8153
7874
|
}) => void;
|
|
8154
7875
|
}
|
|
8155
7876
|
|
|
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
|
-
|
|
8176
7877
|
/** @public */
|
|
8177
7878
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
8178
7879
|
|
|
@@ -8769,26 +8470,6 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8769
8470
|
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8770
8471
|
*/
|
|
8771
8472
|
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;
|
|
8792
8473
|
}
|
|
8793
8474
|
|
|
8794
8475
|
/**
|
|
@@ -8823,16 +8504,6 @@ export declare interface TweenHelper {
|
|
|
8823
8504
|
* @returns a texture-move-continuous mode tween
|
|
8824
8505
|
*/
|
|
8825
8506
|
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'];
|
|
8836
8507
|
}
|
|
8837
8508
|
|
|
8838
8509
|
/**
|
|
@@ -9090,6 +8761,14 @@ export declare interface UiTransformProps {
|
|
|
9090
8761
|
*/
|
|
9091
8762
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9092
8763
|
|
|
8764
|
+
export declare type ValidateCallback<T> = (value: {
|
|
8765
|
+
entity: Entity;
|
|
8766
|
+
currentValue: T | undefined;
|
|
8767
|
+
newValue: T | undefined;
|
|
8768
|
+
senderAddress: string;
|
|
8769
|
+
createdBy: string;
|
|
8770
|
+
}) => boolean;
|
|
8771
|
+
|
|
9093
8772
|
/**
|
|
9094
8773
|
* @public
|
|
9095
8774
|
*/
|