@dcl/playground-assets 7.33.1-44118805139.commit-b0b508d → 7.33.1-44149226847.commit-7d1c56d
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
package/dist/alpha.d.ts
CHANGED
|
@@ -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 */
|
|
@@ -1704,12 +1756,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1704
1756
|
/**
|
|
1705
1757
|
* @public
|
|
1706
1758
|
*/
|
|
1707
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1759
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1708
1760
|
|
|
1709
1761
|
/**
|
|
1710
1762
|
* @public
|
|
1711
1763
|
*/
|
|
1712
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1764
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1713
1765
|
|
|
1714
1766
|
/**
|
|
1715
1767
|
* Min length = 8 bytes
|
|
@@ -1764,7 +1816,8 @@ export declare enum CrdtMessageType {
|
|
|
1764
1816
|
PUT_COMPONENT_NETWORK = 5,
|
|
1765
1817
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1766
1818
|
DELETE_ENTITY_NETWORK = 7,
|
|
1767
|
-
|
|
1819
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1820
|
+
MAX_MESSAGE_TYPE = 9
|
|
1768
1821
|
}
|
|
1769
1822
|
|
|
1770
1823
|
/**
|
|
@@ -1772,6 +1825,8 @@ export declare enum CrdtMessageType {
|
|
|
1772
1825
|
*/
|
|
1773
1826
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1774
1827
|
|
|
1828
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1829
|
+
|
|
1775
1830
|
/**
|
|
1776
1831
|
* @public
|
|
1777
1832
|
*/
|
|
@@ -2551,6 +2606,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2551
2606
|
|
|
2552
2607
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2553
2608
|
|
|
2609
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2610
|
+
|
|
2611
|
+
export declare interface ICreatedByType {
|
|
2612
|
+
address: string;
|
|
2613
|
+
}
|
|
2614
|
+
|
|
2554
2615
|
/**
|
|
2555
2616
|
* @public
|
|
2556
2617
|
*/
|
|
@@ -3037,6 +3098,35 @@ export declare const enum InteractionType {
|
|
|
3037
3098
|
PROXIMITY = 1
|
|
3038
3099
|
}
|
|
3039
3100
|
|
|
3101
|
+
/**
|
|
3102
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
3103
|
+
* This is not exposed to users, only for internal SDK operations
|
|
3104
|
+
*/
|
|
3105
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3106
|
+
/**
|
|
3107
|
+
* @public
|
|
3108
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3109
|
+
*/
|
|
3110
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3111
|
+
/**
|
|
3112
|
+
* @public
|
|
3113
|
+
* Get the iterator to every entity has the component
|
|
3114
|
+
*/
|
|
3115
|
+
iterator(): Iterable<[Entity, any]>;
|
|
3116
|
+
/**
|
|
3117
|
+
* @public
|
|
3118
|
+
*/
|
|
3119
|
+
dirtyIterator(): Iterable<Entity>;
|
|
3120
|
+
/**
|
|
3121
|
+
* @public
|
|
3122
|
+
*/
|
|
3123
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3124
|
+
/**
|
|
3125
|
+
* @public
|
|
3126
|
+
*/
|
|
3127
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3128
|
+
}
|
|
3129
|
+
|
|
3040
3130
|
/**
|
|
3041
3131
|
* @public
|
|
3042
3132
|
*/
|
|
@@ -9800,6 +9890,16 @@ export declare type Transport = {
|
|
|
9800
9890
|
onmessage?(message: Uint8Array): void;
|
|
9801
9891
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9802
9892
|
type?: string;
|
|
9893
|
+
/**
|
|
9894
|
+
* Whether this transport is allowed to mutate reserved-range entities
|
|
9895
|
+
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9896
|
+
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9897
|
+
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9898
|
+
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9899
|
+
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9900
|
+
* `receiveMessages`.
|
|
9901
|
+
*/
|
|
9902
|
+
allowReservedEntities?: boolean;
|
|
9803
9903
|
};
|
|
9804
9904
|
|
|
9805
9905
|
/**
|
|
@@ -10381,6 +10481,14 @@ export declare interface UiTransformProps {
|
|
|
10381
10481
|
*/
|
|
10382
10482
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10383
10483
|
|
|
10484
|
+
export declare type ValidateCallback<T> = (value: {
|
|
10485
|
+
entity: Entity;
|
|
10486
|
+
currentValue: T | undefined;
|
|
10487
|
+
newValue: T | undefined;
|
|
10488
|
+
senderAddress: string;
|
|
10489
|
+
createdBy: string;
|
|
10490
|
+
}) => boolean;
|
|
10491
|
+
|
|
10384
10492
|
/**
|
|
10385
10493
|
* @public
|
|
10386
10494
|
*/
|
package/dist/beta.d.ts
CHANGED
|
@@ -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 */
|
|
@@ -1704,12 +1756,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1704
1756
|
/**
|
|
1705
1757
|
* @public
|
|
1706
1758
|
*/
|
|
1707
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1759
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1708
1760
|
|
|
1709
1761
|
/**
|
|
1710
1762
|
* @public
|
|
1711
1763
|
*/
|
|
1712
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1764
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1713
1765
|
|
|
1714
1766
|
/**
|
|
1715
1767
|
* Min length = 8 bytes
|
|
@@ -1764,7 +1816,8 @@ export declare enum CrdtMessageType {
|
|
|
1764
1816
|
PUT_COMPONENT_NETWORK = 5,
|
|
1765
1817
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1766
1818
|
DELETE_ENTITY_NETWORK = 7,
|
|
1767
|
-
|
|
1819
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1820
|
+
MAX_MESSAGE_TYPE = 9
|
|
1768
1821
|
}
|
|
1769
1822
|
|
|
1770
1823
|
/**
|
|
@@ -1772,6 +1825,8 @@ export declare enum CrdtMessageType {
|
|
|
1772
1825
|
*/
|
|
1773
1826
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1774
1827
|
|
|
1828
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1829
|
+
|
|
1775
1830
|
/**
|
|
1776
1831
|
* @public
|
|
1777
1832
|
*/
|
|
@@ -2551,6 +2606,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2551
2606
|
|
|
2552
2607
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2553
2608
|
|
|
2609
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2610
|
+
|
|
2611
|
+
export declare interface ICreatedByType {
|
|
2612
|
+
address: string;
|
|
2613
|
+
}
|
|
2614
|
+
|
|
2554
2615
|
/**
|
|
2555
2616
|
* @public
|
|
2556
2617
|
*/
|
|
@@ -3028,6 +3089,35 @@ export declare const enum InteractionType {
|
|
|
3028
3089
|
PROXIMITY = 1
|
|
3029
3090
|
}
|
|
3030
3091
|
|
|
3092
|
+
/**
|
|
3093
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
3094
|
+
* This is not exposed to users, only for internal SDK operations
|
|
3095
|
+
*/
|
|
3096
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3097
|
+
/**
|
|
3098
|
+
* @public
|
|
3099
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3100
|
+
*/
|
|
3101
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3102
|
+
/**
|
|
3103
|
+
* @public
|
|
3104
|
+
* Get the iterator to every entity has the component
|
|
3105
|
+
*/
|
|
3106
|
+
iterator(): Iterable<[Entity, any]>;
|
|
3107
|
+
/**
|
|
3108
|
+
* @public
|
|
3109
|
+
*/
|
|
3110
|
+
dirtyIterator(): Iterable<Entity>;
|
|
3111
|
+
/**
|
|
3112
|
+
* @public
|
|
3113
|
+
*/
|
|
3114
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3115
|
+
/**
|
|
3116
|
+
* @public
|
|
3117
|
+
*/
|
|
3118
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3031
3121
|
/**
|
|
3032
3122
|
* @public
|
|
3033
3123
|
*/
|
|
@@ -9767,6 +9857,16 @@ export declare type Transport = {
|
|
|
9767
9857
|
onmessage?(message: Uint8Array): void;
|
|
9768
9858
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9769
9859
|
type?: string;
|
|
9860
|
+
/**
|
|
9861
|
+
* Whether this transport is allowed to mutate reserved-range entities
|
|
9862
|
+
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9863
|
+
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9864
|
+
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9865
|
+
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9866
|
+
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9867
|
+
* `receiveMessages`.
|
|
9868
|
+
*/
|
|
9869
|
+
allowReservedEntities?: boolean;
|
|
9770
9870
|
};
|
|
9771
9871
|
|
|
9772
9872
|
/**
|
|
@@ -10348,6 +10448,14 @@ export declare interface UiTransformProps {
|
|
|
10348
10448
|
*/
|
|
10349
10449
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10350
10450
|
|
|
10451
|
+
export declare type ValidateCallback<T> = (value: {
|
|
10452
|
+
entity: Entity;
|
|
10453
|
+
currentValue: T | undefined;
|
|
10454
|
+
newValue: T | undefined;
|
|
10455
|
+
senderAddress: string;
|
|
10456
|
+
createdBy: string;
|
|
10457
|
+
}) => boolean;
|
|
10458
|
+
|
|
10351
10459
|
/**
|
|
10352
10460
|
* @public
|
|
10353
10461
|
*/
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -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 */
|
|
@@ -1704,12 +1756,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1704
1756
|
/**
|
|
1705
1757
|
* @public
|
|
1706
1758
|
*/
|
|
1707
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1759
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1708
1760
|
|
|
1709
1761
|
/**
|
|
1710
1762
|
* @public
|
|
1711
1763
|
*/
|
|
1712
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1764
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1713
1765
|
|
|
1714
1766
|
/**
|
|
1715
1767
|
* Min length = 8 bytes
|
|
@@ -1764,7 +1816,8 @@ export declare enum CrdtMessageType {
|
|
|
1764
1816
|
PUT_COMPONENT_NETWORK = 5,
|
|
1765
1817
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1766
1818
|
DELETE_ENTITY_NETWORK = 7,
|
|
1767
|
-
|
|
1819
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1820
|
+
MAX_MESSAGE_TYPE = 9
|
|
1768
1821
|
}
|
|
1769
1822
|
|
|
1770
1823
|
/**
|
|
@@ -1772,6 +1825,8 @@ export declare enum CrdtMessageType {
|
|
|
1772
1825
|
*/
|
|
1773
1826
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1774
1827
|
|
|
1828
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1829
|
+
|
|
1775
1830
|
/**
|
|
1776
1831
|
* @public
|
|
1777
1832
|
*/
|
|
@@ -2551,6 +2606,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2551
2606
|
|
|
2552
2607
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2553
2608
|
|
|
2609
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2610
|
+
|
|
2611
|
+
export declare interface ICreatedByType {
|
|
2612
|
+
address: string;
|
|
2613
|
+
}
|
|
2614
|
+
|
|
2554
2615
|
/**
|
|
2555
2616
|
* @public
|
|
2556
2617
|
*/
|
|
@@ -3028,6 +3089,35 @@ export declare const enum InteractionType {
|
|
|
3028
3089
|
PROXIMITY = 1
|
|
3029
3090
|
}
|
|
3030
3091
|
|
|
3092
|
+
/**
|
|
3093
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
3094
|
+
* This is not exposed to users, only for internal SDK operations
|
|
3095
|
+
*/
|
|
3096
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3097
|
+
/**
|
|
3098
|
+
* @public
|
|
3099
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3100
|
+
*/
|
|
3101
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3102
|
+
/**
|
|
3103
|
+
* @public
|
|
3104
|
+
* Get the iterator to every entity has the component
|
|
3105
|
+
*/
|
|
3106
|
+
iterator(): Iterable<[Entity, any]>;
|
|
3107
|
+
/**
|
|
3108
|
+
* @public
|
|
3109
|
+
*/
|
|
3110
|
+
dirtyIterator(): Iterable<Entity>;
|
|
3111
|
+
/**
|
|
3112
|
+
* @public
|
|
3113
|
+
*/
|
|
3114
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3115
|
+
/**
|
|
3116
|
+
* @public
|
|
3117
|
+
*/
|
|
3118
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3031
3121
|
/**
|
|
3032
3122
|
* @public
|
|
3033
3123
|
*/
|
|
@@ -9767,6 +9857,16 @@ export declare type Transport = {
|
|
|
9767
9857
|
onmessage?(message: Uint8Array): void;
|
|
9768
9858
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9769
9859
|
type?: string;
|
|
9860
|
+
/**
|
|
9861
|
+
* Whether this transport is allowed to mutate reserved-range entities
|
|
9862
|
+
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9863
|
+
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9864
|
+
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9865
|
+
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9866
|
+
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9867
|
+
* `receiveMessages`.
|
|
9868
|
+
*/
|
|
9869
|
+
allowReservedEntities?: boolean;
|
|
9770
9870
|
};
|
|
9771
9871
|
|
|
9772
9872
|
/**
|
|
@@ -10348,6 +10448,14 @@ export declare interface UiTransformProps {
|
|
|
10348
10448
|
*/
|
|
10349
10449
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10350
10450
|
|
|
10451
|
+
export declare type ValidateCallback<T> = (value: {
|
|
10452
|
+
entity: Entity;
|
|
10453
|
+
currentValue: T | undefined;
|
|
10454
|
+
newValue: T | undefined;
|
|
10455
|
+
senderAddress: string;
|
|
10456
|
+
createdBy: string;
|
|
10457
|
+
}) => boolean;
|
|
10458
|
+
|
|
10351
10459
|
/**
|
|
10352
10460
|
* @public
|
|
10353
10461
|
*/
|