@dcl/playground-assets 7.29.0 → 7.29.1-35039347300.commit-dffaede
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 +111 -3
- package/dist/beta.d.ts +111 -3
- package/dist/index.bundled.d.ts +111 -3
- package/dist/index.js +7 -7
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +111 -3
- package/etc/playground-assets.api.json +1001 -4
- package/etc/playground-assets.api.md +80 -3
- package/package.json +6 -5
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dcl/sdk",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "7.29.
|
|
4
|
+
"version": "7.29.1-35039347300.commit-dffaede",
|
|
5
5
|
"author": "Decentraland",
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"@dcl/ecs": "file:../ecs",
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
},
|
|
34
34
|
"types": "./index.d.ts",
|
|
35
35
|
"typings": "./index.d.ts",
|
|
36
|
-
"commit": "
|
|
36
|
+
"commit": "dffaede67b4ff56bdfc4af6e6d5d729ee1308767"
|
|
37
37
|
}
|
|
@@ -245,6 +245,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
245
245
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
246
246
|
}
|
|
247
247
|
|
|
248
|
+
/**
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
255
|
+
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
256
|
+
*
|
|
257
|
+
* @param entity - Uint32 number of the entity
|
|
258
|
+
* @param componentId - Uint32 number of id
|
|
259
|
+
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
260
|
+
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export declare type AuthoritativePutComponentMessageBody = {
|
|
264
|
+
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
265
|
+
entityId: Entity;
|
|
266
|
+
componentId: number;
|
|
267
|
+
timestamp: number;
|
|
268
|
+
data: Uint8Array;
|
|
269
|
+
};
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
export declare namespace AuthoritativePutComponentOperation {
|
|
275
|
+
const MESSAGE_HEADER_LENGTH = 16;
|
|
276
|
+
/**
|
|
277
|
+
* Call this function for an optimal writing data passing the ByteBuffer
|
|
278
|
+
* already allocated
|
|
279
|
+
*/
|
|
280
|
+
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
281
|
+
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
282
|
+
}
|
|
283
|
+
|
|
248
284
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
249
285
|
/**
|
|
250
286
|
* @public
|
|
@@ -420,6 +456,22 @@ export declare interface BaseComponent<T> {
|
|
|
420
456
|
* If the value is undefined, the component was deleted.
|
|
421
457
|
*/
|
|
422
458
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
459
|
+
/**
|
|
460
|
+
* @public
|
|
461
|
+
*
|
|
462
|
+
*/
|
|
463
|
+
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
464
|
+
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
465
|
+
/**
|
|
466
|
+
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
467
|
+
* @param entity - Entity to get the CRDT state for
|
|
468
|
+
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
getCrdtState(entity: Entity): {
|
|
472
|
+
data: Uint8Array;
|
|
473
|
+
timestamp: number;
|
|
474
|
+
} | null;
|
|
423
475
|
}
|
|
424
476
|
|
|
425
477
|
/** @public */
|
|
@@ -1662,12 +1714,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1662
1714
|
/**
|
|
1663
1715
|
* @public
|
|
1664
1716
|
*/
|
|
1665
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1717
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1666
1718
|
|
|
1667
1719
|
/**
|
|
1668
1720
|
* @public
|
|
1669
1721
|
*/
|
|
1670
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1722
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1671
1723
|
|
|
1672
1724
|
/**
|
|
1673
1725
|
* Min length = 8 bytes
|
|
@@ -1722,7 +1774,8 @@ export declare enum CrdtMessageType {
|
|
|
1722
1774
|
PUT_COMPONENT_NETWORK = 5,
|
|
1723
1775
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1724
1776
|
DELETE_ENTITY_NETWORK = 7,
|
|
1725
|
-
|
|
1777
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1778
|
+
MAX_MESSAGE_TYPE = 9
|
|
1726
1779
|
}
|
|
1727
1780
|
|
|
1728
1781
|
/**
|
|
@@ -1730,6 +1783,8 @@ export declare enum CrdtMessageType {
|
|
|
1730
1783
|
*/
|
|
1731
1784
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1732
1785
|
|
|
1786
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1787
|
+
|
|
1733
1788
|
/**
|
|
1734
1789
|
* @public
|
|
1735
1790
|
*/
|
|
@@ -2501,6 +2556,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2501
2556
|
|
|
2502
2557
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2503
2558
|
|
|
2559
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2560
|
+
|
|
2561
|
+
export declare interface ICreatedByType {
|
|
2562
|
+
address: string;
|
|
2563
|
+
}
|
|
2564
|
+
|
|
2504
2565
|
/**
|
|
2505
2566
|
* @public
|
|
2506
2567
|
*/
|
|
@@ -2983,6 +3044,35 @@ export declare const enum InteractionType {
|
|
|
2983
3044
|
PROXIMITY = 1
|
|
2984
3045
|
}
|
|
2985
3046
|
|
|
3047
|
+
/**
|
|
3048
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
3049
|
+
* This is not exposed to users, only for internal SDK operations
|
|
3050
|
+
*/
|
|
3051
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3052
|
+
/**
|
|
3053
|
+
* @public
|
|
3054
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3055
|
+
*/
|
|
3056
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3057
|
+
/**
|
|
3058
|
+
* @public
|
|
3059
|
+
* Get the iterator to every entity has the component
|
|
3060
|
+
*/
|
|
3061
|
+
iterator(): Iterable<[Entity, any]>;
|
|
3062
|
+
/**
|
|
3063
|
+
* @public
|
|
3064
|
+
*/
|
|
3065
|
+
dirtyIterator(): Iterable<Entity>;
|
|
3066
|
+
/**
|
|
3067
|
+
* @public
|
|
3068
|
+
*/
|
|
3069
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3070
|
+
/**
|
|
3071
|
+
* @public
|
|
3072
|
+
*/
|
|
3073
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3074
|
+
}
|
|
3075
|
+
|
|
2986
3076
|
/**
|
|
2987
3077
|
* @public
|
|
2988
3078
|
*/
|
|
@@ -9443,6 +9533,16 @@ export declare type Transport = {
|
|
|
9443
9533
|
onmessage?(message: Uint8Array): void;
|
|
9444
9534
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9445
9535
|
type?: string;
|
|
9536
|
+
/**
|
|
9537
|
+
* Whether this transport is allowed to mutate reserved-range entities
|
|
9538
|
+
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9539
|
+
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9540
|
+
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9541
|
+
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9542
|
+
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9543
|
+
* `receiveMessages`.
|
|
9544
|
+
*/
|
|
9545
|
+
allowReservedEntities?: boolean;
|
|
9446
9546
|
};
|
|
9447
9547
|
|
|
9448
9548
|
/**
|
|
@@ -10021,6 +10121,14 @@ export declare interface UiTransformProps {
|
|
|
10021
10121
|
*/
|
|
10022
10122
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10023
10123
|
|
|
10124
|
+
export declare type ValidateCallback<T> = (value: {
|
|
10125
|
+
entity: Entity;
|
|
10126
|
+
currentValue: T | undefined;
|
|
10127
|
+
newValue: T | undefined;
|
|
10128
|
+
senderAddress: string;
|
|
10129
|
+
createdBy: string;
|
|
10130
|
+
}) => boolean;
|
|
10131
|
+
|
|
10024
10132
|
/**
|
|
10025
10133
|
* @public
|
|
10026
10134
|
*/
|