@dcl/playground-assets 7.32.1-41691874543.commit-3063788 → 7.33.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 +9 -111
- package/dist/beta.d.ts +9 -111
- package/dist/index.bundled.d.ts +9 -111
- package/dist/index.js +7 -7
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +9 -111
- package/etc/playground-assets.api.json +32 -1001
- 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 */
|
|
@@ -1756,12 +1704,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1756
1704
|
/**
|
|
1757
1705
|
* @public
|
|
1758
1706
|
*/
|
|
1759
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1707
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1760
1708
|
|
|
1761
1709
|
/**
|
|
1762
1710
|
* @public
|
|
1763
1711
|
*/
|
|
1764
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1712
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1765
1713
|
|
|
1766
1714
|
/**
|
|
1767
1715
|
* Min length = 8 bytes
|
|
@@ -1816,8 +1764,7 @@ export declare enum CrdtMessageType {
|
|
|
1816
1764
|
PUT_COMPONENT_NETWORK = 5,
|
|
1817
1765
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1818
1766
|
DELETE_ENTITY_NETWORK = 7,
|
|
1819
|
-
|
|
1820
|
-
MAX_MESSAGE_TYPE = 9
|
|
1767
|
+
MAX_MESSAGE_TYPE = 8
|
|
1821
1768
|
}
|
|
1822
1769
|
|
|
1823
1770
|
/**
|
|
@@ -1825,8 +1772,6 @@ export declare enum CrdtMessageType {
|
|
|
1825
1772
|
*/
|
|
1826
1773
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1827
1774
|
|
|
1828
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1829
|
-
|
|
1830
1775
|
/**
|
|
1831
1776
|
* @public
|
|
1832
1777
|
*/
|
|
@@ -2606,12 +2551,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2606
2551
|
|
|
2607
2552
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2608
2553
|
|
|
2609
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2610
|
-
|
|
2611
|
-
export declare interface ICreatedByType {
|
|
2612
|
-
address: string;
|
|
2613
|
-
}
|
|
2614
|
-
|
|
2615
2554
|
/**
|
|
2616
2555
|
* @public
|
|
2617
2556
|
*/
|
|
@@ -3098,35 +3037,6 @@ export declare const enum InteractionType {
|
|
|
3098
3037
|
PROXIMITY = 1
|
|
3099
3038
|
}
|
|
3100
3039
|
|
|
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
|
-
|
|
3130
3040
|
/**
|
|
3131
3041
|
* @public
|
|
3132
3042
|
*/
|
|
@@ -9754,6 +9664,12 @@ export declare interface TouchScreenControlsComponentDefinitionExtended extends
|
|
|
9754
9664
|
* Does NOT change the joystick/crosshair — use `showJoystick()` / `showCrosshair()` for those.
|
|
9755
9665
|
*/
|
|
9756
9666
|
showAll(): void;
|
|
9667
|
+
/**
|
|
9668
|
+
* Show the default button set: jump, pointer and primary visible, secondary and
|
|
9669
|
+
* actions 3-6 hidden. This is the state every scene starts in.
|
|
9670
|
+
* Does NOT change the joystick/crosshair, the main action or custom icons.
|
|
9671
|
+
*/
|
|
9672
|
+
showDefault(): void;
|
|
9757
9673
|
/** Hide the given on-screen buttons (merged into the current config). */
|
|
9758
9674
|
hide(actions: InputAction[]): void;
|
|
9759
9675
|
/** Set which action the large central button triggers. */
|
|
@@ -9846,16 +9762,6 @@ export declare type Transport = {
|
|
|
9846
9762
|
onmessage?(message: Uint8Array): void;
|
|
9847
9763
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9848
9764
|
type?: string;
|
|
9849
|
-
/**
|
|
9850
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
9851
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9852
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9853
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9854
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9855
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9856
|
-
* `receiveMessages`.
|
|
9857
|
-
*/
|
|
9858
|
-
allowReservedEntities?: boolean;
|
|
9859
9765
|
};
|
|
9860
9766
|
|
|
9861
9767
|
/**
|
|
@@ -10437,14 +10343,6 @@ export declare interface UiTransformProps {
|
|
|
10437
10343
|
*/
|
|
10438
10344
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10439
10345
|
|
|
10440
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10441
|
-
entity: Entity;
|
|
10442
|
-
currentValue: T | undefined;
|
|
10443
|
-
newValue: T | undefined;
|
|
10444
|
-
senderAddress: string;
|
|
10445
|
-
createdBy: string;
|
|
10446
|
-
}) => boolean;
|
|
10447
|
-
|
|
10448
10346
|
/**
|
|
10449
10347
|
* @public
|
|
10450
10348
|
*/
|
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 */
|
|
@@ -1756,12 +1704,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1756
1704
|
/**
|
|
1757
1705
|
* @public
|
|
1758
1706
|
*/
|
|
1759
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1707
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1760
1708
|
|
|
1761
1709
|
/**
|
|
1762
1710
|
* @public
|
|
1763
1711
|
*/
|
|
1764
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1712
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1765
1713
|
|
|
1766
1714
|
/**
|
|
1767
1715
|
* Min length = 8 bytes
|
|
@@ -1816,8 +1764,7 @@ export declare enum CrdtMessageType {
|
|
|
1816
1764
|
PUT_COMPONENT_NETWORK = 5,
|
|
1817
1765
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1818
1766
|
DELETE_ENTITY_NETWORK = 7,
|
|
1819
|
-
|
|
1820
|
-
MAX_MESSAGE_TYPE = 9
|
|
1767
|
+
MAX_MESSAGE_TYPE = 8
|
|
1821
1768
|
}
|
|
1822
1769
|
|
|
1823
1770
|
/**
|
|
@@ -1825,8 +1772,6 @@ export declare enum CrdtMessageType {
|
|
|
1825
1772
|
*/
|
|
1826
1773
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1827
1774
|
|
|
1828
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1829
|
-
|
|
1830
1775
|
/**
|
|
1831
1776
|
* @public
|
|
1832
1777
|
*/
|
|
@@ -2606,12 +2551,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2606
2551
|
|
|
2607
2552
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2608
2553
|
|
|
2609
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2610
|
-
|
|
2611
|
-
export declare interface ICreatedByType {
|
|
2612
|
-
address: string;
|
|
2613
|
-
}
|
|
2614
|
-
|
|
2615
2554
|
/**
|
|
2616
2555
|
* @public
|
|
2617
2556
|
*/
|
|
@@ -3089,35 +3028,6 @@ export declare const enum InteractionType {
|
|
|
3089
3028
|
PROXIMITY = 1
|
|
3090
3029
|
}
|
|
3091
3030
|
|
|
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
|
-
|
|
3121
3031
|
/**
|
|
3122
3032
|
* @public
|
|
3123
3033
|
*/
|
|
@@ -9721,6 +9631,12 @@ export declare interface TouchScreenControlsComponentDefinitionExtended extends
|
|
|
9721
9631
|
* Does NOT change the joystick/crosshair — use `showJoystick()` / `showCrosshair()` for those.
|
|
9722
9632
|
*/
|
|
9723
9633
|
showAll(): void;
|
|
9634
|
+
/**
|
|
9635
|
+
* Show the default button set: jump, pointer and primary visible, secondary and
|
|
9636
|
+
* actions 3-6 hidden. This is the state every scene starts in.
|
|
9637
|
+
* Does NOT change the joystick/crosshair, the main action or custom icons.
|
|
9638
|
+
*/
|
|
9639
|
+
showDefault(): void;
|
|
9724
9640
|
/** Hide the given on-screen buttons (merged into the current config). */
|
|
9725
9641
|
hide(actions: InputAction[]): void;
|
|
9726
9642
|
/** Set which action the large central button triggers. */
|
|
@@ -9813,16 +9729,6 @@ export declare type Transport = {
|
|
|
9813
9729
|
onmessage?(message: Uint8Array): void;
|
|
9814
9730
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9815
9731
|
type?: string;
|
|
9816
|
-
/**
|
|
9817
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
9818
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9819
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9820
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9821
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9822
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9823
|
-
* `receiveMessages`.
|
|
9824
|
-
*/
|
|
9825
|
-
allowReservedEntities?: boolean;
|
|
9826
9732
|
};
|
|
9827
9733
|
|
|
9828
9734
|
/**
|
|
@@ -10404,14 +10310,6 @@ export declare interface UiTransformProps {
|
|
|
10404
10310
|
*/
|
|
10405
10311
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10406
10312
|
|
|
10407
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10408
|
-
entity: Entity;
|
|
10409
|
-
currentValue: T | undefined;
|
|
10410
|
-
newValue: T | undefined;
|
|
10411
|
-
senderAddress: string;
|
|
10412
|
-
createdBy: string;
|
|
10413
|
-
}) => boolean;
|
|
10414
|
-
|
|
10415
10313
|
/**
|
|
10416
10314
|
* @public
|
|
10417
10315
|
*/
|
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 */
|
|
@@ -1756,12 +1704,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1756
1704
|
/**
|
|
1757
1705
|
* @public
|
|
1758
1706
|
*/
|
|
1759
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1707
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1760
1708
|
|
|
1761
1709
|
/**
|
|
1762
1710
|
* @public
|
|
1763
1711
|
*/
|
|
1764
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1712
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1765
1713
|
|
|
1766
1714
|
/**
|
|
1767
1715
|
* Min length = 8 bytes
|
|
@@ -1816,8 +1764,7 @@ export declare enum CrdtMessageType {
|
|
|
1816
1764
|
PUT_COMPONENT_NETWORK = 5,
|
|
1817
1765
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1818
1766
|
DELETE_ENTITY_NETWORK = 7,
|
|
1819
|
-
|
|
1820
|
-
MAX_MESSAGE_TYPE = 9
|
|
1767
|
+
MAX_MESSAGE_TYPE = 8
|
|
1821
1768
|
}
|
|
1822
1769
|
|
|
1823
1770
|
/**
|
|
@@ -1825,8 +1772,6 @@ export declare enum CrdtMessageType {
|
|
|
1825
1772
|
*/
|
|
1826
1773
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1827
1774
|
|
|
1828
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1829
|
-
|
|
1830
1775
|
/**
|
|
1831
1776
|
* @public
|
|
1832
1777
|
*/
|
|
@@ -2606,12 +2551,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2606
2551
|
|
|
2607
2552
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2608
2553
|
|
|
2609
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2610
|
-
|
|
2611
|
-
export declare interface ICreatedByType {
|
|
2612
|
-
address: string;
|
|
2613
|
-
}
|
|
2614
|
-
|
|
2615
2554
|
/**
|
|
2616
2555
|
* @public
|
|
2617
2556
|
*/
|
|
@@ -3089,35 +3028,6 @@ export declare const enum InteractionType {
|
|
|
3089
3028
|
PROXIMITY = 1
|
|
3090
3029
|
}
|
|
3091
3030
|
|
|
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
|
-
|
|
3121
3031
|
/**
|
|
3122
3032
|
* @public
|
|
3123
3033
|
*/
|
|
@@ -9721,6 +9631,12 @@ export declare interface TouchScreenControlsComponentDefinitionExtended extends
|
|
|
9721
9631
|
* Does NOT change the joystick/crosshair — use `showJoystick()` / `showCrosshair()` for those.
|
|
9722
9632
|
*/
|
|
9723
9633
|
showAll(): void;
|
|
9634
|
+
/**
|
|
9635
|
+
* Show the default button set: jump, pointer and primary visible, secondary and
|
|
9636
|
+
* actions 3-6 hidden. This is the state every scene starts in.
|
|
9637
|
+
* Does NOT change the joystick/crosshair, the main action or custom icons.
|
|
9638
|
+
*/
|
|
9639
|
+
showDefault(): void;
|
|
9724
9640
|
/** Hide the given on-screen buttons (merged into the current config). */
|
|
9725
9641
|
hide(actions: InputAction[]): void;
|
|
9726
9642
|
/** Set which action the large central button triggers. */
|
|
@@ -9813,16 +9729,6 @@ export declare type Transport = {
|
|
|
9813
9729
|
onmessage?(message: Uint8Array): void;
|
|
9814
9730
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
9815
9731
|
type?: string;
|
|
9816
|
-
/**
|
|
9817
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
9818
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9819
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9820
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9821
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9822
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9823
|
-
* `receiveMessages`.
|
|
9824
|
-
*/
|
|
9825
|
-
allowReservedEntities?: boolean;
|
|
9826
9732
|
};
|
|
9827
9733
|
|
|
9828
9734
|
/**
|
|
@@ -10404,14 +10310,6 @@ export declare interface UiTransformProps {
|
|
|
10404
10310
|
*/
|
|
10405
10311
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10406
10312
|
|
|
10407
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10408
|
-
entity: Entity;
|
|
10409
|
-
currentValue: T | undefined;
|
|
10410
|
-
newValue: T | undefined;
|
|
10411
|
-
senderAddress: string;
|
|
10412
|
-
createdBy: string;
|
|
10413
|
-
}) => boolean;
|
|
10414
|
-
|
|
10415
10313
|
/**
|
|
10416
10314
|
* @public
|
|
10417
10315
|
*/
|