@dcl/playground-assets 7.0.6-3823801200.commit-32470bd → 7.0.6-3830539086.commit-6152fbd

package/dist/index.bundled.d.ts

@@ -1057,6 +1057,57 @@ export declare type ComponentSchema<T extends [ComponentDefinition<any>, ...Comp
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
 
+export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
+
+export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | DeleteEntityMessage;
+
+export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessage;
+
+/**
+ * Min length = 8 bytes
+ * All message length including
+ * @param length - Uint32 the length of all message (including the header)
+ * @param type - define the function which handles the data
+ */
+export declare type CrdtMessageHeader = {
+    length: Uint32;
+    type: Uint32;
+};
+
+export declare namespace CrdtMessageProtocol {
+    /**
+     * Validate if the message incoming is completed
+     * @param buf - ByteBuffer
+     */
+    export function validate(buf: ByteBuffer): boolean;
+    /**
+     * Get the current header, consuming the bytes involved.
+     * @param buf - ByteBuffer
+     * @returns header or null if there is no validated message
+     */
+    export function readHeader(buf: ByteBuffer): CrdtMessageHeader | null;
+    /**
+     * Get the current header, without consuming the bytes involved.
+     * @param buf - ByteBuffer
+     * @returns header or null if there is no validated message
+     */
+    export function getHeader(buf: ByteBuffer): CrdtMessageHeader | null;
+    /**
+     * Consume the incoming message without processing it.
+     * @param buf - ByteBuffer
+     * @returns true in case of success or false if there is no valid message.
+     */
+    export function consumeMessage(buf: ByteBuffer): boolean;
+}
+
+export declare enum CrdtMessageType {
+    RESERVED = 0,
+    PUT_COMPONENT = 1,
+    DELETE_COMPONENT = 2,
+    DELETE_ENTITY = 3,
+    MAX_MESSAGE_TYPE = 4
+}
+
 export declare function createEthereumProvider(): {
     send(message: RPCSendableMessage, callback?: ((error: Error | null, result?: any) => void) | undefined): void;
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
@@ -1150,6 +1201,40 @@ export declare function defineComponent<T>(componentId: number, spec: ISchema<T>
  */
 export declare const DEG2RAD: number;
 
+export declare namespace DeleteComponent {
+    const MESSAGE_HEADER_LENGTH = 20;
+    /**
+     * Write DeleteComponent message
+     */
+    export function write(entity: Entity, componentId: number, timestamp: number, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): DeleteComponentMessage | null;
+}
+
+export declare type DeleteComponentMessage = CrdtMessageHeader & DeleteComponentMessageBody;
+
+export declare type DeleteComponentMessageBody = {
+    type: CrdtMessageType.DELETE_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+};
+
+export declare namespace DeleteEntity {
+    const MESSAGE_HEADER_LENGTH = 4;
+    export function write(entity: Entity, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): DeleteEntityMessage | null;
+}
+
+export declare type DeleteEntityMessage = CrdtMessageHeader & DeleteEntityMessageBody;
+
+/**
+ * @param entity - Uint32 number of the entity
+ */
+export declare type DeleteEntityMessageBody = {
+    type: CrdtMessageType.DELETE_ENTITY;
+    entityId: Entity;
+};
+
 /**
  * @public
  */
@@ -1183,7 +1268,7 @@ export declare type EngineEvent<T extends IEventNames = IEventNames, V = IEvents
  * Convertion from its compound numbers to entity:
  * entity = (entityNumber & MAX_U16) | ((entityVersion & MAX_U16) << 16)
  */
-export declare type Entity = uint32 & {
+export declare type Entity = number & {
     __entity_type: '';
 };
 
@@ -1197,14 +1282,16 @@ export declare type EntityComponents = {
     onMouseUp: Callback;
 };
 
-export declare function EntityContainer(): {
+export declare function EntityContainer(): EntityContainer;
+
+export declare type EntityContainer = {
     generateEntity(): Entity;
     removeEntity(entity: Entity): boolean;
-    entityExists(entity: Entity): boolean;
+    getEntityState(entity: Entity): EntityState;
     getExistingEntities(): Set<Entity>;
-    entityVersion: (entity: Entity) => number;
-    entityNumber: (entity: Entity) => number;
-    entityId: (entityNumber: number, entityVersion: number) => Entity;
+    releaseRemovedEntities(): Entity[];
+    updateRemovedEntity(entity: Entity): boolean;
+    updateUsedEntity(entity: Entity): boolean;
 };
 
 /**
@@ -1215,6 +1302,36 @@ export declare type EntityPropTypes = {
     uiBackground?: UiBackgroundProps;
 } & Listeners & Pick<CommonProps, 'key'>;
 
+/**
+ * @public
+ */
+export declare enum EntityState {
+    Unknown = 0,
+    /**
+     * The entity was generated and added to the usedEntities set
+     */
+    UsedEntity = 1,
+    /**
+     * The entity was removed from current engine or remotely
+     */
+    Removed = 2,
+    /**
+     * The entity is reserved number.
+     */
+    Reserved = 3
+}
+
+export declare namespace EntityUtils {
+    /**
+     * @returns [entityNumber, entityVersion]
+     */
+    export function fromEntityId(entityId: Entity): [number, number];
+    /**
+     * @returns compound number from entityNumber and entityVerison
+     */
+    export function toEntityId(entityNumber: number, entityVersion: number): Entity;
+}
+
 /**
  * Constant used to define the minimal number value in Babylon.js
  * @public
@@ -1298,11 +1415,11 @@ export declare type IEngine = {
      */
     removeEntityWithChildren(firstEntity: Entity): void;
     /**
-     * Check if an entity exists in the engine
+     * Check the state of an entityin  the engine
      * @param entity - the entity to validate
-     * @returns true if the entity exists in the engine
+     * @returns known enum value
      */
-    entityExists(entity: Entity): boolean;
+    getEntityState(entity: Entity): EntityState;
     /**
      * Add the system to the engine. It will be called every tick updated.
      * @param system - function that receives the delta time between last tick and current one.
@@ -1418,6 +1535,10 @@ export declare type IEngine = {
      * @param transport - transport which changes its onmessage to process CRDT messages
      */
     addTransport(transport: Transport): void;
+    /**
+     * Entity continaer
+     */
+    entityContainer: EntityContainer;
     /**
      * Iterator of registered components
      */
@@ -2651,7 +2772,7 @@ export declare class ObserverEventState {
 /**
  * @public
  */
-export declare type OnChangeFunction = (entity: Entity, component: ComponentDefinition<any>, operation: WireMessage.Enum) => void;
+export declare type OnChangeFunction = (entity: Entity, operation: CrdtMessageType, component?: ComponentDefinition<any>) => void;
 
 export declare const onCommsMessage: Observable<{
     sender: string;
@@ -3758,6 +3879,34 @@ export declare type Position = {
 
 export declare type PositionUnit = `${number}px` | `${number}%` | number;
 
+export declare type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
+
+/**
+ * Min. length = header (8 bytes) + 20 bytes = 28 bytes
+ *
+ * @param entity - Uint32 number of the entity
+ * @param componentId - Uint32 number of id
+ * @param timestamp - Uint64 Lamport timestamp
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ */
+export declare type PutComponentMessageBody = {
+    type: CrdtMessageType.PUT_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+    data: Uint8Array;
+};
+
+export declare namespace PutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 20;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    export function write(entity: Entity, timestamp: number, componentDefinition: ComponentDefinition<unknown>, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): PutComponentMessage | null;
+}
+
 /**
  * @public
  * Quaternion is a type and a namespace.
@@ -4086,13 +4235,8 @@ export declare type ReadonlyComponentSchema<T extends [ComponentDefinition<unkno
  */
 export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
 
-export declare type ReceiveMessage = {
-    type: WireMessage.Enum;
-    entity: Entity;
-    componentId: number;
-    timestamp: number;
+export declare type ReceiveMessage = CrdtMessageBody & {
     transportId?: number;
-    data?: Uint8Array;
     messageBuffer: Uint8Array;
 };
 
@@ -4541,6 +4685,8 @@ export declare type UiInputProps = PBUiInput & {
 /** @public */
 export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
 
+export declare type Uint32 = number;
+
 /**
  * @public It only defines the type explicitly, no effects.
  */
@@ -5208,32 +5354,6 @@ export declare type Vector3Type = {
 /** @public */
 export declare const VisibilityComponent: ComponentDefinition<PBVisibilityComponent>;
 
-export declare namespace WireMessage {
-    export type Uint32 = number;
-    export enum Enum {
-        RESERVED = 0,
-        PUT_COMPONENT = 1,
-        DELETE_COMPONENT = 2,
-        MAX_MESSAGE_TYPE = 3
-    }
-    /**
-     * @param length - Uint32 the length of all message (including the header)
-     * @param type - define the function which handles the data
-     */
-    export type Header = {
-        length: Uint32;
-        type: Uint32;
-    };
-    const HEADER_LENGTH = 8;
-    /**
-     * Validate if the message incoming is completed
-     * @param buf - ByteBuffer
-     */
-    export function validate(buf: ByteBuffer): boolean;
-    export function readHeader(buf: ByteBuffer): Header | null;
-    export function getType(component: ComponentDefinition<unknown>, entity: Entity): Enum;
-}
-
 export declare const enum YGAlign {
     YGA_AUTO = 0,
     YGA_FLEX_START = 1,