@dcl/playground-assets 7.28.1-34955459026.commit-7db2d46 → 7.29.0
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 +13 -111
- package/dist/beta.d.ts +13 -111
- package/dist/index.bundled.d.ts +13 -111
- package/dist/index.js +7 -7
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +13 -111
- package/etc/playground-assets.api.json +5 -1002
- package/etc/playground-assets.api.md +4 -80
- package/package.json +5 -6
package/dist/alpha.d.ts
CHANGED
|
@@ -245,42 +245,6 @@ 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
|
-
|
|
284
248
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
285
249
|
/**
|
|
286
250
|
* @public
|
|
@@ -456,22 +420,6 @@ export declare interface BaseComponent<T> {
|
|
|
456
420
|
* If the value is undefined, the component was deleted.
|
|
457
421
|
*/
|
|
458
422
|
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;
|
|
475
423
|
}
|
|
476
424
|
|
|
477
425
|
/** @public */
|
|
@@ -1714,12 +1662,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1714
1662
|
/**
|
|
1715
1663
|
* @public
|
|
1716
1664
|
*/
|
|
1717
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1665
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1718
1666
|
|
|
1719
1667
|
/**
|
|
1720
1668
|
* @public
|
|
1721
1669
|
*/
|
|
1722
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1670
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1723
1671
|
|
|
1724
1672
|
/**
|
|
1725
1673
|
* Min length = 8 bytes
|
|
@@ -1774,8 +1722,7 @@ export declare enum CrdtMessageType {
|
|
|
1774
1722
|
PUT_COMPONENT_NETWORK = 5,
|
|
1775
1723
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1776
1724
|
DELETE_ENTITY_NETWORK = 7,
|
|
1777
|
-
|
|
1778
|
-
MAX_MESSAGE_TYPE = 9
|
|
1725
|
+
MAX_MESSAGE_TYPE = 8
|
|
1779
1726
|
}
|
|
1780
1727
|
|
|
1781
1728
|
/**
|
|
@@ -1783,8 +1730,6 @@ export declare enum CrdtMessageType {
|
|
|
1783
1730
|
*/
|
|
1784
1731
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1785
1732
|
|
|
1786
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1787
|
-
|
|
1788
1733
|
/**
|
|
1789
1734
|
* @public
|
|
1790
1735
|
*/
|
|
@@ -2556,12 +2501,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2556
2501
|
|
|
2557
2502
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2558
2503
|
|
|
2559
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2560
|
-
|
|
2561
|
-
export declare interface ICreatedByType {
|
|
2562
|
-
address: string;
|
|
2563
|
-
}
|
|
2564
|
-
|
|
2565
2504
|
/**
|
|
2566
2505
|
* @public
|
|
2567
2506
|
*/
|
|
@@ -3044,35 +2983,6 @@ export declare const enum InteractionType {
|
|
|
3044
2983
|
PROXIMITY = 1
|
|
3045
2984
|
}
|
|
3046
2985
|
|
|
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
|
-
|
|
3076
2986
|
/**
|
|
3077
2987
|
* @public
|
|
3078
2988
|
*/
|
|
@@ -9533,16 +9443,6 @@ export declare type Transport = {
|
|
|
9533
9443
|
onmessage?(message: Uint8Array): void;
|
|
9534
9444
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9535
9445
|
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;
|
|
9546
9446
|
};
|
|
9547
9447
|
|
|
9548
9448
|
/**
|
|
@@ -9990,6 +9890,16 @@ export declare type UiRendererOptions = {
|
|
|
9990
9890
|
* can use different insets simultaneously.
|
|
9991
9891
|
*/
|
|
9992
9892
|
screenInset?: UiScreenInset;
|
|
9893
|
+
/**
|
|
9894
|
+
* Stacking order of this renderer's UI relative to the other renderers (the main
|
|
9895
|
+
* one and every `addUiRenderer`). Higher values render in front. When omitted,
|
|
9896
|
+
* renderers stack in the order they first render, later ones on top; among those
|
|
9897
|
+
* first rendered in the same tick the main UI goes at the back.
|
|
9898
|
+
*
|
|
9899
|
+
* It is applied to the renderer's root container entity, so it only orders whole
|
|
9900
|
+
* renderers against each other; elements inside a renderer keep their own `zIndex`.
|
|
9901
|
+
*/
|
|
9902
|
+
zIndex?: number;
|
|
9993
9903
|
};
|
|
9994
9904
|
|
|
9995
9905
|
/**
|
|
@@ -10111,14 +10021,6 @@ export declare interface UiTransformProps {
|
|
|
10111
10021
|
*/
|
|
10112
10022
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10113
10023
|
|
|
10114
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10115
|
-
entity: Entity;
|
|
10116
|
-
currentValue: T | undefined;
|
|
10117
|
-
newValue: T | undefined;
|
|
10118
|
-
senderAddress: string;
|
|
10119
|
-
createdBy: string;
|
|
10120
|
-
}) => boolean;
|
|
10121
|
-
|
|
10122
10024
|
/**
|
|
10123
10025
|
* @public
|
|
10124
10026
|
*/
|
package/dist/beta.d.ts
CHANGED
|
@@ -245,42 +245,6 @@ 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
|
-
|
|
284
248
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
285
249
|
/**
|
|
286
250
|
* @public
|
|
@@ -456,22 +420,6 @@ export declare interface BaseComponent<T> {
|
|
|
456
420
|
* If the value is undefined, the component was deleted.
|
|
457
421
|
*/
|
|
458
422
|
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;
|
|
475
423
|
}
|
|
476
424
|
|
|
477
425
|
/** @public */
|
|
@@ -1714,12 +1662,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1714
1662
|
/**
|
|
1715
1663
|
* @public
|
|
1716
1664
|
*/
|
|
1717
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1665
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1718
1666
|
|
|
1719
1667
|
/**
|
|
1720
1668
|
* @public
|
|
1721
1669
|
*/
|
|
1722
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1670
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1723
1671
|
|
|
1724
1672
|
/**
|
|
1725
1673
|
* Min length = 8 bytes
|
|
@@ -1774,8 +1722,7 @@ export declare enum CrdtMessageType {
|
|
|
1774
1722
|
PUT_COMPONENT_NETWORK = 5,
|
|
1775
1723
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1776
1724
|
DELETE_ENTITY_NETWORK = 7,
|
|
1777
|
-
|
|
1778
|
-
MAX_MESSAGE_TYPE = 9
|
|
1725
|
+
MAX_MESSAGE_TYPE = 8
|
|
1779
1726
|
}
|
|
1780
1727
|
|
|
1781
1728
|
/**
|
|
@@ -1783,8 +1730,6 @@ export declare enum CrdtMessageType {
|
|
|
1783
1730
|
*/
|
|
1784
1731
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1785
1732
|
|
|
1786
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1787
|
-
|
|
1788
1733
|
/**
|
|
1789
1734
|
* @public
|
|
1790
1735
|
*/
|
|
@@ -2556,12 +2501,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2556
2501
|
|
|
2557
2502
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2558
2503
|
|
|
2559
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2560
|
-
|
|
2561
|
-
export declare interface ICreatedByType {
|
|
2562
|
-
address: string;
|
|
2563
|
-
}
|
|
2564
|
-
|
|
2565
2504
|
/**
|
|
2566
2505
|
* @public
|
|
2567
2506
|
*/
|
|
@@ -3035,35 +2974,6 @@ export declare const enum InteractionType {
|
|
|
3035
2974
|
PROXIMITY = 1
|
|
3036
2975
|
}
|
|
3037
2976
|
|
|
3038
|
-
/**
|
|
3039
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
3040
|
-
* This is not exposed to users, only for internal SDK operations
|
|
3041
|
-
*/
|
|
3042
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3043
|
-
/**
|
|
3044
|
-
* @public
|
|
3045
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3046
|
-
*/
|
|
3047
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3048
|
-
/**
|
|
3049
|
-
* @public
|
|
3050
|
-
* Get the iterator to every entity has the component
|
|
3051
|
-
*/
|
|
3052
|
-
iterator(): Iterable<[Entity, any]>;
|
|
3053
|
-
/**
|
|
3054
|
-
* @public
|
|
3055
|
-
*/
|
|
3056
|
-
dirtyIterator(): Iterable<Entity>;
|
|
3057
|
-
/**
|
|
3058
|
-
* @public
|
|
3059
|
-
*/
|
|
3060
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3061
|
-
/**
|
|
3062
|
-
* @public
|
|
3063
|
-
*/
|
|
3064
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3065
|
-
}
|
|
3066
|
-
|
|
3067
2977
|
/**
|
|
3068
2978
|
* @public
|
|
3069
2979
|
*/
|
|
@@ -9500,16 +9410,6 @@ export declare type Transport = {
|
|
|
9500
9410
|
onmessage?(message: Uint8Array): void;
|
|
9501
9411
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9502
9412
|
type?: string;
|
|
9503
|
-
/**
|
|
9504
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
9505
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9506
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9507
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9508
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9509
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9510
|
-
* `receiveMessages`.
|
|
9511
|
-
*/
|
|
9512
|
-
allowReservedEntities?: boolean;
|
|
9513
9413
|
};
|
|
9514
9414
|
|
|
9515
9415
|
/**
|
|
@@ -9957,6 +9857,16 @@ export declare type UiRendererOptions = {
|
|
|
9957
9857
|
* can use different insets simultaneously.
|
|
9958
9858
|
*/
|
|
9959
9859
|
screenInset?: UiScreenInset;
|
|
9860
|
+
/**
|
|
9861
|
+
* Stacking order of this renderer's UI relative to the other renderers (the main
|
|
9862
|
+
* one and every `addUiRenderer`). Higher values render in front. When omitted,
|
|
9863
|
+
* renderers stack in the order they first render, later ones on top; among those
|
|
9864
|
+
* first rendered in the same tick the main UI goes at the back.
|
|
9865
|
+
*
|
|
9866
|
+
* It is applied to the renderer's root container entity, so it only orders whole
|
|
9867
|
+
* renderers against each other; elements inside a renderer keep their own `zIndex`.
|
|
9868
|
+
*/
|
|
9869
|
+
zIndex?: number;
|
|
9960
9870
|
};
|
|
9961
9871
|
|
|
9962
9872
|
/**
|
|
@@ -10078,14 +9988,6 @@ export declare interface UiTransformProps {
|
|
|
10078
9988
|
*/
|
|
10079
9989
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10080
9990
|
|
|
10081
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10082
|
-
entity: Entity;
|
|
10083
|
-
currentValue: T | undefined;
|
|
10084
|
-
newValue: T | undefined;
|
|
10085
|
-
senderAddress: string;
|
|
10086
|
-
createdBy: string;
|
|
10087
|
-
}) => boolean;
|
|
10088
|
-
|
|
10089
9991
|
/**
|
|
10090
9992
|
* @public
|
|
10091
9993
|
*/
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -245,42 +245,6 @@ 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
|
-
|
|
284
248
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
285
249
|
/**
|
|
286
250
|
* @public
|
|
@@ -456,22 +420,6 @@ export declare interface BaseComponent<T> {
|
|
|
456
420
|
* If the value is undefined, the component was deleted.
|
|
457
421
|
*/
|
|
458
422
|
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;
|
|
475
423
|
}
|
|
476
424
|
|
|
477
425
|
/** @public */
|
|
@@ -1714,12 +1662,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1714
1662
|
/**
|
|
1715
1663
|
* @public
|
|
1716
1664
|
*/
|
|
1717
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1665
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1718
1666
|
|
|
1719
1667
|
/**
|
|
1720
1668
|
* @public
|
|
1721
1669
|
*/
|
|
1722
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1670
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1723
1671
|
|
|
1724
1672
|
/**
|
|
1725
1673
|
* Min length = 8 bytes
|
|
@@ -1774,8 +1722,7 @@ export declare enum CrdtMessageType {
|
|
|
1774
1722
|
PUT_COMPONENT_NETWORK = 5,
|
|
1775
1723
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1776
1724
|
DELETE_ENTITY_NETWORK = 7,
|
|
1777
|
-
|
|
1778
|
-
MAX_MESSAGE_TYPE = 9
|
|
1725
|
+
MAX_MESSAGE_TYPE = 8
|
|
1779
1726
|
}
|
|
1780
1727
|
|
|
1781
1728
|
/**
|
|
@@ -1783,8 +1730,6 @@ export declare enum CrdtMessageType {
|
|
|
1783
1730
|
*/
|
|
1784
1731
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1785
1732
|
|
|
1786
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1787
|
-
|
|
1788
1733
|
/**
|
|
1789
1734
|
* @public
|
|
1790
1735
|
*/
|
|
@@ -2556,12 +2501,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2556
2501
|
|
|
2557
2502
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2558
2503
|
|
|
2559
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2560
|
-
|
|
2561
|
-
export declare interface ICreatedByType {
|
|
2562
|
-
address: string;
|
|
2563
|
-
}
|
|
2564
|
-
|
|
2565
2504
|
/**
|
|
2566
2505
|
* @public
|
|
2567
2506
|
*/
|
|
@@ -3035,35 +2974,6 @@ export declare const enum InteractionType {
|
|
|
3035
2974
|
PROXIMITY = 1
|
|
3036
2975
|
}
|
|
3037
2976
|
|
|
3038
|
-
/**
|
|
3039
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
3040
|
-
* This is not exposed to users, only for internal SDK operations
|
|
3041
|
-
*/
|
|
3042
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3043
|
-
/**
|
|
3044
|
-
* @public
|
|
3045
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3046
|
-
*/
|
|
3047
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3048
|
-
/**
|
|
3049
|
-
* @public
|
|
3050
|
-
* Get the iterator to every entity has the component
|
|
3051
|
-
*/
|
|
3052
|
-
iterator(): Iterable<[Entity, any]>;
|
|
3053
|
-
/**
|
|
3054
|
-
* @public
|
|
3055
|
-
*/
|
|
3056
|
-
dirtyIterator(): Iterable<Entity>;
|
|
3057
|
-
/**
|
|
3058
|
-
* @public
|
|
3059
|
-
*/
|
|
3060
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3061
|
-
/**
|
|
3062
|
-
* @public
|
|
3063
|
-
*/
|
|
3064
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3065
|
-
}
|
|
3066
|
-
|
|
3067
2977
|
/**
|
|
3068
2978
|
* @public
|
|
3069
2979
|
*/
|
|
@@ -9500,16 +9410,6 @@ export declare type Transport = {
|
|
|
9500
9410
|
onmessage?(message: Uint8Array): void;
|
|
9501
9411
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9502
9412
|
type?: string;
|
|
9503
|
-
/**
|
|
9504
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
9505
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9506
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9507
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9508
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9509
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9510
|
-
* `receiveMessages`.
|
|
9511
|
-
*/
|
|
9512
|
-
allowReservedEntities?: boolean;
|
|
9513
9413
|
};
|
|
9514
9414
|
|
|
9515
9415
|
/**
|
|
@@ -9957,6 +9857,16 @@ export declare type UiRendererOptions = {
|
|
|
9957
9857
|
* can use different insets simultaneously.
|
|
9958
9858
|
*/
|
|
9959
9859
|
screenInset?: UiScreenInset;
|
|
9860
|
+
/**
|
|
9861
|
+
* Stacking order of this renderer's UI relative to the other renderers (the main
|
|
9862
|
+
* one and every `addUiRenderer`). Higher values render in front. When omitted,
|
|
9863
|
+
* renderers stack in the order they first render, later ones on top; among those
|
|
9864
|
+
* first rendered in the same tick the main UI goes at the back.
|
|
9865
|
+
*
|
|
9866
|
+
* It is applied to the renderer's root container entity, so it only orders whole
|
|
9867
|
+
* renderers against each other; elements inside a renderer keep their own `zIndex`.
|
|
9868
|
+
*/
|
|
9869
|
+
zIndex?: number;
|
|
9960
9870
|
};
|
|
9961
9871
|
|
|
9962
9872
|
/**
|
|
@@ -10078,14 +9988,6 @@ export declare interface UiTransformProps {
|
|
|
10078
9988
|
*/
|
|
10079
9989
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10080
9990
|
|
|
10081
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10082
|
-
entity: Entity;
|
|
10083
|
-
currentValue: T | undefined;
|
|
10084
|
-
newValue: T | undefined;
|
|
10085
|
-
senderAddress: string;
|
|
10086
|
-
createdBy: string;
|
|
10087
|
-
}) => boolean;
|
|
10088
|
-
|
|
10089
9991
|
/**
|
|
10090
9992
|
* @public
|
|
10091
9993
|
*/
|