@dcl/playground-assets 7.23.2-25521226778.commit-1828100 → 7.23.2-25802088407.commit-15e8697
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 +8 -101
- package/dist/beta.d.ts +8 -101
- package/dist/index.bundled.d.ts +8 -101
- package/dist/index.js +9 -9
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +8 -101
- package/etc/playground-assets.api.json +4 -1001
- package/etc/playground-assets.api.md +3 -79
- package/package.json +5 -6
package/dist/alpha.d.ts
CHANGED
|
@@ -218,42 +218,6 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
218
218
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
|
-
/**
|
|
222
|
-
* @public
|
|
223
|
-
*/
|
|
224
|
-
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
228
|
-
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
229
|
-
*
|
|
230
|
-
* @param entity - Uint32 number of the entity
|
|
231
|
-
* @param componentId - Uint32 number of id
|
|
232
|
-
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
233
|
-
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
234
|
-
* @public
|
|
235
|
-
*/
|
|
236
|
-
export declare type AuthoritativePutComponentMessageBody = {
|
|
237
|
-
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
238
|
-
entityId: Entity;
|
|
239
|
-
componentId: number;
|
|
240
|
-
timestamp: number;
|
|
241
|
-
data: Uint8Array;
|
|
242
|
-
};
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
export declare namespace AuthoritativePutComponentOperation {
|
|
248
|
-
const MESSAGE_HEADER_LENGTH = 16;
|
|
249
|
-
/**
|
|
250
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
251
|
-
* already allocated
|
|
252
|
-
*/
|
|
253
|
-
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
254
|
-
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
255
|
-
}
|
|
256
|
-
|
|
257
221
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
258
222
|
/**
|
|
259
223
|
* @public
|
|
@@ -416,22 +380,6 @@ export declare interface BaseComponent<T> {
|
|
|
416
380
|
* If the value is undefined, the component was deleted.
|
|
417
381
|
*/
|
|
418
382
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
419
|
-
/**
|
|
420
|
-
* @public
|
|
421
|
-
*
|
|
422
|
-
*/
|
|
423
|
-
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
424
|
-
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
425
|
-
/**
|
|
426
|
-
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
427
|
-
* @param entity - Entity to get the CRDT state for
|
|
428
|
-
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
429
|
-
* @public
|
|
430
|
-
*/
|
|
431
|
-
getCrdtState(entity: Entity): {
|
|
432
|
-
data: Uint8Array;
|
|
433
|
-
timestamp: number;
|
|
434
|
-
} | null;
|
|
435
383
|
}
|
|
436
384
|
|
|
437
385
|
/** @public */
|
|
@@ -1662,12 +1610,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1662
1610
|
/**
|
|
1663
1611
|
* @public
|
|
1664
1612
|
*/
|
|
1665
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1613
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1666
1614
|
|
|
1667
1615
|
/**
|
|
1668
1616
|
* @public
|
|
1669
1617
|
*/
|
|
1670
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1618
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1671
1619
|
|
|
1672
1620
|
/**
|
|
1673
1621
|
* Min length = 8 bytes
|
|
@@ -1722,8 +1670,7 @@ export declare enum CrdtMessageType {
|
|
|
1722
1670
|
PUT_COMPONENT_NETWORK = 5,
|
|
1723
1671
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1724
1672
|
DELETE_ENTITY_NETWORK = 7,
|
|
1725
|
-
|
|
1726
|
-
MAX_MESSAGE_TYPE = 9
|
|
1673
|
+
MAX_MESSAGE_TYPE = 8
|
|
1727
1674
|
}
|
|
1728
1675
|
|
|
1729
1676
|
/**
|
|
@@ -1731,8 +1678,6 @@ export declare enum CrdtMessageType {
|
|
|
1731
1678
|
*/
|
|
1732
1679
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1733
1680
|
|
|
1734
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1735
|
-
|
|
1736
1681
|
/**
|
|
1737
1682
|
* @public
|
|
1738
1683
|
*/
|
|
@@ -2452,12 +2397,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2452
2397
|
|
|
2453
2398
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2454
2399
|
|
|
2455
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2456
|
-
|
|
2457
|
-
export declare interface ICreatedByType {
|
|
2458
|
-
address: string;
|
|
2459
|
-
}
|
|
2460
|
-
|
|
2461
2400
|
/**
|
|
2462
2401
|
* @public
|
|
2463
2402
|
*/
|
|
@@ -2911,35 +2850,6 @@ export declare const enum InteractionType {
|
|
|
2911
2850
|
PROXIMITY = 1
|
|
2912
2851
|
}
|
|
2913
2852
|
|
|
2914
|
-
/**
|
|
2915
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
2916
|
-
* This is not exposed to users, only for internal SDK operations
|
|
2917
|
-
*/
|
|
2918
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2919
|
-
/**
|
|
2920
|
-
* @public
|
|
2921
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2922
|
-
*/
|
|
2923
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2924
|
-
/**
|
|
2925
|
-
* @public
|
|
2926
|
-
* Get the iterator to every entity has the component
|
|
2927
|
-
*/
|
|
2928
|
-
iterator(): Iterable<[Entity, any]>;
|
|
2929
|
-
/**
|
|
2930
|
-
* @public
|
|
2931
|
-
*/
|
|
2932
|
-
dirtyIterator(): Iterable<Entity>;
|
|
2933
|
-
/**
|
|
2934
|
-
* @public
|
|
2935
|
-
*/
|
|
2936
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2937
|
-
/**
|
|
2938
|
-
* @public
|
|
2939
|
-
*/
|
|
2940
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2941
|
-
}
|
|
2942
|
-
|
|
2943
2853
|
/**
|
|
2944
2854
|
* @public
|
|
2945
2855
|
*/
|
|
@@ -9140,6 +9050,11 @@ export declare interface TriggerAreaEventsSystem {
|
|
|
9140
9050
|
* Execute callback when an entity stays in the Trigger Area
|
|
9141
9051
|
* @param entity - The entity that already has the TriggerArea component
|
|
9142
9052
|
* @param cb - Function to execute the 'Stay' type of result is detected
|
|
9053
|
+
*
|
|
9054
|
+
* Note: stay callbacks are synthesized by the SDK on every tick between a wire ENTER and a wire EXIT.
|
|
9055
|
+
* Wire-level TAET_STAY events (still emitted by legacy Explorers) are ignored entirely — they neither
|
|
9056
|
+
* fire callbacks nor mutate state. The SDK is the sole source of onTriggerStay dispatches, driven
|
|
9057
|
+
* from the ENTER/EXIT state machine.
|
|
9143
9058
|
*/
|
|
9144
9059
|
onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
9145
9060
|
/**
|
|
@@ -9586,14 +9501,6 @@ export declare interface UiTransformProps {
|
|
|
9586
9501
|
*/
|
|
9587
9502
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9588
9503
|
|
|
9589
|
-
export declare type ValidateCallback<T> = (value: {
|
|
9590
|
-
entity: Entity;
|
|
9591
|
-
currentValue: T | undefined;
|
|
9592
|
-
newValue: T | undefined;
|
|
9593
|
-
senderAddress: string;
|
|
9594
|
-
createdBy: string;
|
|
9595
|
-
}) => boolean;
|
|
9596
|
-
|
|
9597
9504
|
/**
|
|
9598
9505
|
* @public
|
|
9599
9506
|
*/
|
package/dist/beta.d.ts
CHANGED
|
@@ -218,42 +218,6 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
218
218
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
|
-
/**
|
|
222
|
-
* @public
|
|
223
|
-
*/
|
|
224
|
-
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
228
|
-
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
229
|
-
*
|
|
230
|
-
* @param entity - Uint32 number of the entity
|
|
231
|
-
* @param componentId - Uint32 number of id
|
|
232
|
-
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
233
|
-
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
234
|
-
* @public
|
|
235
|
-
*/
|
|
236
|
-
export declare type AuthoritativePutComponentMessageBody = {
|
|
237
|
-
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
238
|
-
entityId: Entity;
|
|
239
|
-
componentId: number;
|
|
240
|
-
timestamp: number;
|
|
241
|
-
data: Uint8Array;
|
|
242
|
-
};
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
export declare namespace AuthoritativePutComponentOperation {
|
|
248
|
-
const MESSAGE_HEADER_LENGTH = 16;
|
|
249
|
-
/**
|
|
250
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
251
|
-
* already allocated
|
|
252
|
-
*/
|
|
253
|
-
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
254
|
-
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
255
|
-
}
|
|
256
|
-
|
|
257
221
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
258
222
|
/**
|
|
259
223
|
* @public
|
|
@@ -416,22 +380,6 @@ export declare interface BaseComponent<T> {
|
|
|
416
380
|
* If the value is undefined, the component was deleted.
|
|
417
381
|
*/
|
|
418
382
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
419
|
-
/**
|
|
420
|
-
* @public
|
|
421
|
-
*
|
|
422
|
-
*/
|
|
423
|
-
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
424
|
-
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
425
|
-
/**
|
|
426
|
-
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
427
|
-
* @param entity - Entity to get the CRDT state for
|
|
428
|
-
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
429
|
-
* @public
|
|
430
|
-
*/
|
|
431
|
-
getCrdtState(entity: Entity): {
|
|
432
|
-
data: Uint8Array;
|
|
433
|
-
timestamp: number;
|
|
434
|
-
} | null;
|
|
435
383
|
}
|
|
436
384
|
|
|
437
385
|
/** @public */
|
|
@@ -1662,12 +1610,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1662
1610
|
/**
|
|
1663
1611
|
* @public
|
|
1664
1612
|
*/
|
|
1665
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1613
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1666
1614
|
|
|
1667
1615
|
/**
|
|
1668
1616
|
* @public
|
|
1669
1617
|
*/
|
|
1670
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1618
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1671
1619
|
|
|
1672
1620
|
/**
|
|
1673
1621
|
* Min length = 8 bytes
|
|
@@ -1722,8 +1670,7 @@ export declare enum CrdtMessageType {
|
|
|
1722
1670
|
PUT_COMPONENT_NETWORK = 5,
|
|
1723
1671
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1724
1672
|
DELETE_ENTITY_NETWORK = 7,
|
|
1725
|
-
|
|
1726
|
-
MAX_MESSAGE_TYPE = 9
|
|
1673
|
+
MAX_MESSAGE_TYPE = 8
|
|
1727
1674
|
}
|
|
1728
1675
|
|
|
1729
1676
|
/**
|
|
@@ -1731,8 +1678,6 @@ export declare enum CrdtMessageType {
|
|
|
1731
1678
|
*/
|
|
1732
1679
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1733
1680
|
|
|
1734
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1735
|
-
|
|
1736
1681
|
/**
|
|
1737
1682
|
* @public
|
|
1738
1683
|
*/
|
|
@@ -2452,12 +2397,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2452
2397
|
|
|
2453
2398
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2454
2399
|
|
|
2455
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2456
|
-
|
|
2457
|
-
export declare interface ICreatedByType {
|
|
2458
|
-
address: string;
|
|
2459
|
-
}
|
|
2460
|
-
|
|
2461
2400
|
/**
|
|
2462
2401
|
* @public
|
|
2463
2402
|
*/
|
|
@@ -2902,35 +2841,6 @@ export declare const enum InteractionType {
|
|
|
2902
2841
|
PROXIMITY = 1
|
|
2903
2842
|
}
|
|
2904
2843
|
|
|
2905
|
-
/**
|
|
2906
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
2907
|
-
* This is not exposed to users, only for internal SDK operations
|
|
2908
|
-
*/
|
|
2909
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2910
|
-
/**
|
|
2911
|
-
* @public
|
|
2912
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2913
|
-
*/
|
|
2914
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2915
|
-
/**
|
|
2916
|
-
* @public
|
|
2917
|
-
* Get the iterator to every entity has the component
|
|
2918
|
-
*/
|
|
2919
|
-
iterator(): Iterable<[Entity, any]>;
|
|
2920
|
-
/**
|
|
2921
|
-
* @public
|
|
2922
|
-
*/
|
|
2923
|
-
dirtyIterator(): Iterable<Entity>;
|
|
2924
|
-
/**
|
|
2925
|
-
* @public
|
|
2926
|
-
*/
|
|
2927
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2928
|
-
/**
|
|
2929
|
-
* @public
|
|
2930
|
-
*/
|
|
2931
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2932
|
-
}
|
|
2933
|
-
|
|
2934
2844
|
/**
|
|
2935
2845
|
* @public
|
|
2936
2846
|
*/
|
|
@@ -9107,6 +9017,11 @@ export declare interface TriggerAreaEventsSystem {
|
|
|
9107
9017
|
* Execute callback when an entity stays in the Trigger Area
|
|
9108
9018
|
* @param entity - The entity that already has the TriggerArea component
|
|
9109
9019
|
* @param cb - Function to execute the 'Stay' type of result is detected
|
|
9020
|
+
*
|
|
9021
|
+
* Note: stay callbacks are synthesized by the SDK on every tick between a wire ENTER and a wire EXIT.
|
|
9022
|
+
* Wire-level TAET_STAY events (still emitted by legacy Explorers) are ignored entirely — they neither
|
|
9023
|
+
* fire callbacks nor mutate state. The SDK is the sole source of onTriggerStay dispatches, driven
|
|
9024
|
+
* from the ENTER/EXIT state machine.
|
|
9110
9025
|
*/
|
|
9111
9026
|
onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
9112
9027
|
/**
|
|
@@ -9553,14 +9468,6 @@ export declare interface UiTransformProps {
|
|
|
9553
9468
|
*/
|
|
9554
9469
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9555
9470
|
|
|
9556
|
-
export declare type ValidateCallback<T> = (value: {
|
|
9557
|
-
entity: Entity;
|
|
9558
|
-
currentValue: T | undefined;
|
|
9559
|
-
newValue: T | undefined;
|
|
9560
|
-
senderAddress: string;
|
|
9561
|
-
createdBy: string;
|
|
9562
|
-
}) => boolean;
|
|
9563
|
-
|
|
9564
9471
|
/**
|
|
9565
9472
|
* @public
|
|
9566
9473
|
*/
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -218,42 +218,6 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
218
218
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
|
-
/**
|
|
222
|
-
* @public
|
|
223
|
-
*/
|
|
224
|
-
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
228
|
-
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
229
|
-
*
|
|
230
|
-
* @param entity - Uint32 number of the entity
|
|
231
|
-
* @param componentId - Uint32 number of id
|
|
232
|
-
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
233
|
-
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
234
|
-
* @public
|
|
235
|
-
*/
|
|
236
|
-
export declare type AuthoritativePutComponentMessageBody = {
|
|
237
|
-
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
238
|
-
entityId: Entity;
|
|
239
|
-
componentId: number;
|
|
240
|
-
timestamp: number;
|
|
241
|
-
data: Uint8Array;
|
|
242
|
-
};
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
export declare namespace AuthoritativePutComponentOperation {
|
|
248
|
-
const MESSAGE_HEADER_LENGTH = 16;
|
|
249
|
-
/**
|
|
250
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
251
|
-
* already allocated
|
|
252
|
-
*/
|
|
253
|
-
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
254
|
-
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
255
|
-
}
|
|
256
|
-
|
|
257
221
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
258
222
|
/**
|
|
259
223
|
* @public
|
|
@@ -416,22 +380,6 @@ export declare interface BaseComponent<T> {
|
|
|
416
380
|
* If the value is undefined, the component was deleted.
|
|
417
381
|
*/
|
|
418
382
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
419
|
-
/**
|
|
420
|
-
* @public
|
|
421
|
-
*
|
|
422
|
-
*/
|
|
423
|
-
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
424
|
-
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
425
|
-
/**
|
|
426
|
-
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
427
|
-
* @param entity - Entity to get the CRDT state for
|
|
428
|
-
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
429
|
-
* @public
|
|
430
|
-
*/
|
|
431
|
-
getCrdtState(entity: Entity): {
|
|
432
|
-
data: Uint8Array;
|
|
433
|
-
timestamp: number;
|
|
434
|
-
} | null;
|
|
435
383
|
}
|
|
436
384
|
|
|
437
385
|
/** @public */
|
|
@@ -1662,12 +1610,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1662
1610
|
/**
|
|
1663
1611
|
* @public
|
|
1664
1612
|
*/
|
|
1665
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1613
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1666
1614
|
|
|
1667
1615
|
/**
|
|
1668
1616
|
* @public
|
|
1669
1617
|
*/
|
|
1670
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1618
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1671
1619
|
|
|
1672
1620
|
/**
|
|
1673
1621
|
* Min length = 8 bytes
|
|
@@ -1722,8 +1670,7 @@ export declare enum CrdtMessageType {
|
|
|
1722
1670
|
PUT_COMPONENT_NETWORK = 5,
|
|
1723
1671
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1724
1672
|
DELETE_ENTITY_NETWORK = 7,
|
|
1725
|
-
|
|
1726
|
-
MAX_MESSAGE_TYPE = 9
|
|
1673
|
+
MAX_MESSAGE_TYPE = 8
|
|
1727
1674
|
}
|
|
1728
1675
|
|
|
1729
1676
|
/**
|
|
@@ -1731,8 +1678,6 @@ export declare enum CrdtMessageType {
|
|
|
1731
1678
|
*/
|
|
1732
1679
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1733
1680
|
|
|
1734
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1735
|
-
|
|
1736
1681
|
/**
|
|
1737
1682
|
* @public
|
|
1738
1683
|
*/
|
|
@@ -2452,12 +2397,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2452
2397
|
|
|
2453
2398
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2454
2399
|
|
|
2455
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2456
|
-
|
|
2457
|
-
export declare interface ICreatedByType {
|
|
2458
|
-
address: string;
|
|
2459
|
-
}
|
|
2460
|
-
|
|
2461
2400
|
/**
|
|
2462
2401
|
* @public
|
|
2463
2402
|
*/
|
|
@@ -2902,35 +2841,6 @@ export declare const enum InteractionType {
|
|
|
2902
2841
|
PROXIMITY = 1
|
|
2903
2842
|
}
|
|
2904
2843
|
|
|
2905
|
-
/**
|
|
2906
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
2907
|
-
* This is not exposed to users, only for internal SDK operations
|
|
2908
|
-
*/
|
|
2909
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2910
|
-
/**
|
|
2911
|
-
* @public
|
|
2912
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2913
|
-
*/
|
|
2914
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2915
|
-
/**
|
|
2916
|
-
* @public
|
|
2917
|
-
* Get the iterator to every entity has the component
|
|
2918
|
-
*/
|
|
2919
|
-
iterator(): Iterable<[Entity, any]>;
|
|
2920
|
-
/**
|
|
2921
|
-
* @public
|
|
2922
|
-
*/
|
|
2923
|
-
dirtyIterator(): Iterable<Entity>;
|
|
2924
|
-
/**
|
|
2925
|
-
* @public
|
|
2926
|
-
*/
|
|
2927
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2928
|
-
/**
|
|
2929
|
-
* @public
|
|
2930
|
-
*/
|
|
2931
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2932
|
-
}
|
|
2933
|
-
|
|
2934
2844
|
/**
|
|
2935
2845
|
* @public
|
|
2936
2846
|
*/
|
|
@@ -9107,6 +9017,11 @@ export declare interface TriggerAreaEventsSystem {
|
|
|
9107
9017
|
* Execute callback when an entity stays in the Trigger Area
|
|
9108
9018
|
* @param entity - The entity that already has the TriggerArea component
|
|
9109
9019
|
* @param cb - Function to execute the 'Stay' type of result is detected
|
|
9020
|
+
*
|
|
9021
|
+
* Note: stay callbacks are synthesized by the SDK on every tick between a wire ENTER and a wire EXIT.
|
|
9022
|
+
* Wire-level TAET_STAY events (still emitted by legacy Explorers) are ignored entirely — they neither
|
|
9023
|
+
* fire callbacks nor mutate state. The SDK is the sole source of onTriggerStay dispatches, driven
|
|
9024
|
+
* from the ENTER/EXIT state machine.
|
|
9110
9025
|
*/
|
|
9111
9026
|
onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
9112
9027
|
/**
|
|
@@ -9553,14 +9468,6 @@ export declare interface UiTransformProps {
|
|
|
9553
9468
|
*/
|
|
9554
9469
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9555
9470
|
|
|
9556
|
-
export declare type ValidateCallback<T> = (value: {
|
|
9557
|
-
entity: Entity;
|
|
9558
|
-
currentValue: T | undefined;
|
|
9559
|
-
newValue: T | undefined;
|
|
9560
|
-
senderAddress: string;
|
|
9561
|
-
createdBy: string;
|
|
9562
|
-
}) => boolean;
|
|
9563
|
-
|
|
9564
9471
|
/**
|
|
9565
9472
|
* @public
|
|
9566
9473
|
*/
|