@dcl/playground-assets 7.20.5-22639691829.commit-b96024f → 7.20.5-22673942652.commit-fcc5752
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 +139 -102
- package/dist/beta.d.ts +139 -102
- package/dist/index.bundled.d.ts +139 -102
- 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-assets.d.ts +139 -102
- package/etc/playground-assets.api.json +1945 -1613
- package/etc/playground-assets.api.md +94 -79
- package/package.json +5 -6
package/dist/alpha.d.ts
CHANGED
|
@@ -163,42 +163,6 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
163
163
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
164
164
|
}
|
|
165
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
|
-
|
|
202
166
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
203
167
|
/**
|
|
204
168
|
* @public
|
|
@@ -358,22 +322,6 @@ export declare interface BaseComponent<T> {
|
|
|
358
322
|
* If the value is undefined, the component was deleted.
|
|
359
323
|
*/
|
|
360
324
|
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
325
|
}
|
|
378
326
|
|
|
379
327
|
/** @public */
|
|
@@ -1396,6 +1344,8 @@ export declare const componentDefinitionByName: {
|
|
|
1396
1344
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
|
1397
1345
|
"core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
|
|
1398
1346
|
"core::NftShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBNftShape>>;
|
|
1347
|
+
"core::PhysicsCombinedForce": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>>;
|
|
1348
|
+
"core::PhysicsCombinedImpulse": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>>;
|
|
1399
1349
|
"core::PlayerIdentityData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPlayerIdentityData>>;
|
|
1400
1350
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
|
1401
1351
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
|
@@ -1582,12 +1532,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1582
1532
|
/**
|
|
1583
1533
|
* @public
|
|
1584
1534
|
*/
|
|
1585
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1535
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1586
1536
|
|
|
1587
1537
|
/**
|
|
1588
1538
|
* @public
|
|
1589
1539
|
*/
|
|
1590
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1540
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1591
1541
|
|
|
1592
1542
|
/**
|
|
1593
1543
|
* Min length = 8 bytes
|
|
@@ -1642,8 +1592,7 @@ export declare enum CrdtMessageType {
|
|
|
1642
1592
|
PUT_COMPONENT_NETWORK = 5,
|
|
1643
1593
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1644
1594
|
DELETE_ENTITY_NETWORK = 7,
|
|
1645
|
-
|
|
1646
|
-
MAX_MESSAGE_TYPE = 9
|
|
1595
|
+
MAX_MESSAGE_TYPE = 8
|
|
1647
1596
|
}
|
|
1648
1597
|
|
|
1649
1598
|
/**
|
|
@@ -1651,8 +1600,6 @@ export declare enum CrdtMessageType {
|
|
|
1651
1600
|
*/
|
|
1652
1601
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1653
1602
|
|
|
1654
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1655
|
-
|
|
1656
1603
|
/**
|
|
1657
1604
|
* @public
|
|
1658
1605
|
*/
|
|
@@ -2345,12 +2292,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2345
2292
|
|
|
2346
2293
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2347
2294
|
|
|
2348
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2349
|
-
|
|
2350
|
-
export declare interface ICreatedByType {
|
|
2351
|
-
address: string;
|
|
2352
|
-
}
|
|
2353
|
-
|
|
2354
2295
|
/**
|
|
2355
2296
|
* @public
|
|
2356
2297
|
*/
|
|
@@ -2794,35 +2735,6 @@ export declare type InstanceCompositeOptions = {
|
|
|
2794
2735
|
alreadyRequestedSrc?: Set<string>;
|
|
2795
2736
|
};
|
|
2796
2737
|
|
|
2797
|
-
/**
|
|
2798
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
2799
|
-
* This is not exposed to users, only for internal SDK operations
|
|
2800
|
-
*/
|
|
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;
|
|
2824
|
-
}
|
|
2825
|
-
|
|
2826
2738
|
/**
|
|
2827
2739
|
* @public
|
|
2828
2740
|
*/
|
|
@@ -4001,6 +3913,49 @@ export declare namespace MoveContinuous {
|
|
|
4001
3913
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4002
3914
|
}
|
|
4003
3915
|
|
|
3916
|
+
/**
|
|
3917
|
+
* @public
|
|
3918
|
+
*/
|
|
3919
|
+
export declare interface MoveRotateScale {
|
|
3920
|
+
positionStart: PBVector3 | undefined;
|
|
3921
|
+
positionEnd: PBVector3 | undefined;
|
|
3922
|
+
rotationStart: PBQuaternion | undefined;
|
|
3923
|
+
rotationEnd: PBQuaternion | undefined;
|
|
3924
|
+
scaleStart: PBVector3 | undefined;
|
|
3925
|
+
scaleEnd: PBVector3 | undefined;
|
|
3926
|
+
}
|
|
3927
|
+
|
|
3928
|
+
/**
|
|
3929
|
+
* @public
|
|
3930
|
+
*/
|
|
3931
|
+
export declare namespace MoveRotateScale {
|
|
3932
|
+
export function encode(message: MoveRotateScale, writer?: _m0.Writer): _m0.Writer;
|
|
3933
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScale;
|
|
3934
|
+
}
|
|
3935
|
+
|
|
3936
|
+
/**
|
|
3937
|
+
* @public
|
|
3938
|
+
* Partial params for Tween.Mode.MoveRotateScale(). At least one of position, rotation, or scale must be provided.
|
|
3939
|
+
* Use this when building a mode for Tween.createOrReplace() or TweenSequence (e.g. only positionStart/positionEnd).
|
|
3940
|
+
*/
|
|
3941
|
+
export declare interface MoveRotateScaleModeParams {
|
|
3942
|
+
/** Position tween (start → end). Optional. */
|
|
3943
|
+
position?: {
|
|
3944
|
+
start: PBVector3;
|
|
3945
|
+
end: PBVector3;
|
|
3946
|
+
};
|
|
3947
|
+
/** Rotation tween (start → end). Optional. */
|
|
3948
|
+
rotation?: {
|
|
3949
|
+
start: PBQuaternion;
|
|
3950
|
+
end: PBQuaternion;
|
|
3951
|
+
};
|
|
3952
|
+
/** Scale tween (start → end). Optional. */
|
|
3953
|
+
scale?: {
|
|
3954
|
+
start: PBVector3;
|
|
3955
|
+
end: PBVector3;
|
|
3956
|
+
};
|
|
3957
|
+
}
|
|
3958
|
+
|
|
4004
3959
|
export declare const Name: NameComponent;
|
|
4005
3960
|
|
|
4006
3961
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -5015,6 +4970,8 @@ export declare interface PBInputModifier_StandardInput {
|
|
|
5015
4970
|
disableRun?: boolean | undefined;
|
|
5016
4971
|
disableJump?: boolean | undefined;
|
|
5017
4972
|
disableEmote?: boolean | undefined;
|
|
4973
|
+
disableDoubleJump?: boolean | undefined;
|
|
4974
|
+
disableGliding?: boolean | undefined;
|
|
5018
4975
|
}
|
|
5019
4976
|
|
|
5020
4977
|
/**
|
|
@@ -5436,6 +5393,59 @@ export declare namespace PBNftShape {
|
|
|
5436
5393
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
|
|
5437
5394
|
}
|
|
5438
5395
|
|
|
5396
|
+
/**
|
|
5397
|
+
* This component applies a continuous physics force.
|
|
5398
|
+
*
|
|
5399
|
+
* @remarks Low-level component. Use Physics.applyForceToPlayer()/.removeForceToPlayer() instead.
|
|
5400
|
+
* Direct manipulation will conflict with the force accumulation registry.
|
|
5401
|
+
* Summary component: stores the accumulated result of all active forces registered by the scene in the current frame.
|
|
5402
|
+
*
|
|
5403
|
+
* State-like component: the force is applied every physics tick while the component is present on the entity.
|
|
5404
|
+
*/
|
|
5405
|
+
/**
|
|
5406
|
+
* @public
|
|
5407
|
+
*/
|
|
5408
|
+
export declare interface PBPhysicsCombinedForce {
|
|
5409
|
+
/** Includes force direction and magnitude */
|
|
5410
|
+
vector: PBVector3 | undefined;
|
|
5411
|
+
}
|
|
5412
|
+
|
|
5413
|
+
/**
|
|
5414
|
+
* @public
|
|
5415
|
+
*/
|
|
5416
|
+
export declare namespace PBPhysicsCombinedForce {
|
|
5417
|
+
export function encode(message: PBPhysicsCombinedForce, writer?: _m0.Writer): _m0.Writer;
|
|
5418
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPhysicsCombinedForce;
|
|
5419
|
+
}
|
|
5420
|
+
|
|
5421
|
+
/**
|
|
5422
|
+
* This component applies a one-shot physics summary impulse.
|
|
5423
|
+
*
|
|
5424
|
+
* @remarks Low-level component. Use Physics.applyImpulseToPlayer() instead.
|
|
5425
|
+
* Direct manipulation will conflict with the force accumulation registry.
|
|
5426
|
+
* Summary component: stores the accumulated result of all impulses registered by the scene in the current frame.
|
|
5427
|
+
*
|
|
5428
|
+
* 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.
|
|
5429
|
+
* Renderer processes impulse with the unique ID only once. Increase eventID of the component to apply another impulse.
|
|
5430
|
+
*/
|
|
5431
|
+
/**
|
|
5432
|
+
* @public
|
|
5433
|
+
*/
|
|
5434
|
+
export declare interface PBPhysicsCombinedImpulse {
|
|
5435
|
+
/** Includes impulse direction and magnitude */
|
|
5436
|
+
vector: PBVector3 | undefined;
|
|
5437
|
+
/** Monotonic counter to distinguish different impulses. */
|
|
5438
|
+
eventId: number;
|
|
5439
|
+
}
|
|
5440
|
+
|
|
5441
|
+
/**
|
|
5442
|
+
* @public
|
|
5443
|
+
*/
|
|
5444
|
+
export declare namespace PBPhysicsCombinedImpulse {
|
|
5445
|
+
export function encode(message: PBPhysicsCombinedImpulse, writer?: _m0.Writer): _m0.Writer;
|
|
5446
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPhysicsCombinedImpulse;
|
|
5447
|
+
}
|
|
5448
|
+
|
|
5439
5449
|
/**
|
|
5440
5450
|
* PlayerIdentityData is used to read the information about the avatar's
|
|
5441
5451
|
* identity. this component is written by the engine using the communications
|
|
@@ -5982,6 +5992,9 @@ export declare interface PBTween {
|
|
|
5982
5992
|
} | {
|
|
5983
5993
|
$case: "textureMoveContinuous";
|
|
5984
5994
|
textureMoveContinuous: TextureMoveContinuous;
|
|
5995
|
+
} | {
|
|
5996
|
+
$case: "moveRotateScale";
|
|
5997
|
+
moveRotateScale: MoveRotateScale;
|
|
5985
5998
|
} | undefined;
|
|
5986
5999
|
/** default true (pause or running) */
|
|
5987
6000
|
playing?: boolean | undefined;
|
|
@@ -6460,6 +6473,12 @@ export declare namespace PBVisibilityComponent {
|
|
|
6460
6473
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6461
6474
|
}
|
|
6462
6475
|
|
|
6476
|
+
/** @public */
|
|
6477
|
+
export declare const PhysicsCombinedForce: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>;
|
|
6478
|
+
|
|
6479
|
+
/** @public */
|
|
6480
|
+
export declare const PhysicsCombinedImpulse: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>;
|
|
6481
|
+
|
|
6463
6482
|
/**
|
|
6464
6483
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6465
6484
|
* @public
|
|
@@ -7902,6 +7921,17 @@ export declare namespace Schemas {
|
|
|
7902
7921
|
}) => void;
|
|
7903
7922
|
}
|
|
7904
7923
|
|
|
7924
|
+
/**
|
|
7925
|
+
* @public
|
|
7926
|
+
* Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
|
|
7927
|
+
*/
|
|
7928
|
+
export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModeParams {
|
|
7929
|
+
/** Duration of the tween in milliseconds. */
|
|
7930
|
+
duration: number;
|
|
7931
|
+
/** Easing function (defaults to EF_LINEAR). */
|
|
7932
|
+
easingFunction?: EasingFunction;
|
|
7933
|
+
}
|
|
7934
|
+
|
|
7905
7935
|
/** @public */
|
|
7906
7936
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7907
7937
|
|
|
@@ -8424,7 +8454,7 @@ export declare const Tween: TweenComponentDefinitionExtended;
|
|
|
8424
8454
|
*/
|
|
8425
8455
|
export declare interface TweenComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTween> {
|
|
8426
8456
|
/**
|
|
8427
|
-
*
|
|
8457
|
+
* Helpers with constructor
|
|
8428
8458
|
*/
|
|
8429
8459
|
Mode: TweenHelper;
|
|
8430
8460
|
/**
|
|
@@ -8503,6 +8533,16 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8503
8533
|
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8504
8534
|
*/
|
|
8505
8535
|
setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
|
|
8536
|
+
/**
|
|
8537
|
+
* @public
|
|
8538
|
+
*
|
|
8539
|
+
* Creates or replaces a move-rotate-scale tween component that simultaneously animates
|
|
8540
|
+
* an entity's position, rotation, and/or scale from start to end. Provide only the
|
|
8541
|
+
* properties you need (at least one of position, rotation, or scale).
|
|
8542
|
+
* @param entity - entity to apply the tween to
|
|
8543
|
+
* @param params - object with optional position, rotation, scale (each with start/end), duration, and optional easingFunction
|
|
8544
|
+
*/
|
|
8545
|
+
setMoveRotateScale(entity: Entity, params: SetMoveRotateScaleParams): void;
|
|
8506
8546
|
}
|
|
8507
8547
|
|
|
8508
8548
|
/**
|
|
@@ -8537,6 +8577,11 @@ export declare interface TweenHelper {
|
|
|
8537
8577
|
* @returns a texture-move-continuous mode tween
|
|
8538
8578
|
*/
|
|
8539
8579
|
TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
|
|
8580
|
+
/**
|
|
8581
|
+
* @returns a move-rotate-scale mode tween
|
|
8582
|
+
* @param params - partial transform (at least one of position, rotation, scale); omit axes you don't need
|
|
8583
|
+
*/
|
|
8584
|
+
MoveRotateScale: (params: MoveRotateScaleModeParams) => PBTween['mode'];
|
|
8540
8585
|
}
|
|
8541
8586
|
|
|
8542
8587
|
/**
|
|
@@ -8794,14 +8839,6 @@ export declare interface UiTransformProps {
|
|
|
8794
8839
|
*/
|
|
8795
8840
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
8796
8841
|
|
|
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
8842
|
/**
|
|
8806
8843
|
* @public
|
|
8807
8844
|
*/
|