@dcl/sdk 7.0.0-2536021667.commit-17c845c → 7.0.0-2536579928.commit-004d2e1

package/dist/ecs7/index.d.ts

@@ -22,9 +22,9 @@ export declare type ComponentDefinition<T extends EcsType = EcsType<any>> = {
     has(entity: Entity): boolean;
     getFrom(entity: Entity): DeepReadonly<ComponentType<T>>;
     getOrNull(entity: Entity): DeepReadonly<ComponentType<T>> | null;
-    create(entity: Entity, val: ComponentType<T>): ComponentType<T>;
+    create(entity: Entity, val?: ComponentType<T>): ComponentType<T>;
     mutable(entity: Entity): ComponentType<T>;
-    createOrReplace(entity: Entity, val: ComponentType<T>): ComponentType<T>;
+    createOrReplace(entity: Entity, val?: ComponentType<T>): ComponentType<T>;
     deleteFrom(entity: Entity): ComponentType<T> | null;
     upsertFromBinary(entity: Entity, data: ByteBuffer): ComponentType<T> | null;
     updateFromBinary(entity: Entity, data: ByteBuffer): ComponentType<T> | null;
@@ -193,6 +193,7 @@ declare function defineSdkComponents(engine: Pick<IEngine, 'defineComponent'>):
     PlaneShape: ComponentDefinition<EcsType<PBPlaneShape>>;
     SphereShape: ComponentDefinition<EcsType<PBSphereShape>>;
     TextShape: ComponentDefinition<EcsType<PBTextShape>>;
+    UiTransform: ComponentDefinition<EcsType<PBUiTransform>>;
     Transform: ComponentDefinition<EcsType<Transform>>;
 };
 
@@ -226,12 +227,21 @@ export declare const EcsString: EcsType<string>;
 export declare type EcsType<T = any> = {
     serialize(value: T, builder: ByteBuffer): void;
     deserialize(reader: ByteBuffer): T;
+    create(): T;
 };
 
 /**
  * @public
  */
-export declare function Engine(): IEngine;
+export declare function Engine({ transports }?: {
+    transports?: Transport[];
+}): IEngine;
+
+/**
+ * @alpha * This file initialization is an alpha one. This is based on the old-ecs
+ * init and it'll be changing.
+ */
+export declare const engine: IEngine;
 
 /**
  * @public
@@ -1106,6 +1116,7 @@ declare interface PBAudioStream {
 declare interface PBBoxShape {
     withCollisions: boolean;
     isPointerBlocker: boolean;
+    /** TODO: should visible be another component? that maybe affects all the entities */
     visible: boolean;
     uvs: number[];
 }
@@ -1113,6 +1124,7 @@ declare interface PBBoxShape {
 declare interface PBCylinderShape {
     withCollisions: boolean;
     isPointerBlocker: boolean;
+    /** TODO: should visible be another component? that maybe affects all the entities */
     visible: boolean;
     radiusTop: number;
     radiusBottom: number;
@@ -1121,6 +1133,7 @@ declare interface PBCylinderShape {
 declare interface PBNFTShape {
     withCollisions: boolean;
     isPointerBlocker: boolean;
+    /** TODO: should visible be another component? that maybe affects all the entities */
     visible: boolean;
     src: string;
     assetId: string;
@@ -1131,7 +1144,9 @@ declare interface PBNFTShape {
 declare interface PBPlaneShape {
     withCollisions: boolean;
     isPointerBlocker: boolean;
+    /** TODO: should visible be another component? that maybe affects all the entities */
     visible: boolean;
+    /** TODO: this could be better serialized as u00 v00 u01 v01 u10 v10 u11 v11 for speed */
     uvs: number[];
 }
 
@@ -1143,6 +1158,7 @@ declare interface PBSphereShape {
 
 declare interface PBTextShape {
     text: string;
+    /** this should be removed */
     visible: boolean;
     font: string;
     opacity: number;
@@ -1168,6 +1184,65 @@ declare interface PBTextShape {
     textColor: Color3 | undefined;
 }
 
+declare interface PBUiTransform {
+    positionType: YGPositionType;
+    alignContent: YGAlign;
+    alignItems: YGAlign;
+    alignSelf: YGAlign;
+    flexDirection: YGFlexDirection;
+    flexWrap: YGWrap;
+    justifyContent: YGJustify;
+    overflow: YGOverflow;
+    display: YGDisplay;
+    direction: YGDirection;
+    flex: number;
+    flexBasisUnit: YGUnit;
+    flexBasis: number;
+    flexGrow: number;
+    flexShrink: number;
+    widthUnit: YGUnit;
+    width: number;
+    heightUnit: YGUnit;
+    height: number;
+    minWidthUnit: YGUnit;
+    minWidth: number;
+    minHeightUnit: YGUnit;
+    minHeight: number;
+    maxWidthUnit: YGUnit;
+    maxWidth: number;
+    maxHeightUnit: YGUnit;
+    maxHeight: number;
+    positionLeftUnit: YGUnit;
+    positionLeft: number;
+    positionTopUnit: YGUnit;
+    positionTop: number;
+    positionRightUnit: YGUnit;
+    positionRight: number;
+    positionBottomUnit: YGUnit;
+    positionBottom: number;
+    /** margin */
+    marginLeftUnit: YGUnit;
+    marginLeft: number;
+    marginTopUnit: YGUnit;
+    marginTop: number;
+    marginRightUnit: YGUnit;
+    marginRight: number;
+    marginBottomUnit: YGUnit;
+    marginBottom: number;
+    paddingLeftUnit: YGUnit;
+    paddingLeft: number;
+    paddingTopUnit: YGUnit;
+    paddingTop: number;
+    paddingRightUnit: YGUnit;
+    paddingRight: number;
+    paddingBottomUnit: YGUnit;
+    paddingBottom: number;
+    borderLeft: number;
+    borderTop: number;
+    borderRight: number;
+    borderBottom: number;
+}
+
 /**
  * Represens a plane by the equation ax + by + cz + d = 0
  * @public
@@ -1447,6 +1522,15 @@ export declare namespace Quaternion {
  */
 export declare const RAD2DEG: number;
 
+declare type ReceiveMessage = {
+    entity: Entity;
+    componentId: number;
+    timestamp: number;
+    transportType?: string;
+    data: Uint8Array;
+    messageBuffer: Uint8Array;
+};
+
 /**
  * @public
  */
@@ -1505,6 +1589,15 @@ declare type Transform = {
 
 declare const Transform: EcsType<Transform>;
 
+declare type Transport = {
+    type: string;
+    send(message: Uint8Array): void;
+    onmessage?(message: Uint8Array): void;
+    filter(message: TransportMessage): boolean;
+};
+
+declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
+
 /**
  * @public
  */
@@ -1718,4 +1811,76 @@ export declare namespace Vector3 {
     export function Left(): MutableVector3;
 }
 
+declare enum YGAlign {
+    YGAlignAuto = 0,
+    YGAlignFlexStart = 1,
+    YGAlignCenter = 2,
+    YGAlignFlexEnd = 3,
+    YGAlignStretch = 4,
+    YGAlignBaseline = 5,
+    YGAlignSpaceBetween = 6,
+    YGAlignSpaceAround = 7,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGDirection {
+    YGDirectionInherit = 0,
+    YGDirectionLTR = 1,
+    YGDirectionRTL = 2,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGDisplay {
+    YGDisplayFlex = 0,
+    YGDisplayNone = 1,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGFlexDirection {
+    YGFlexDirectionColumn = 0,
+    YGFlexDirectionColumnReverse = 1,
+    YGFlexDirectionRow = 2,
+    YGFlexDirectionRowReverse = 3,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGJustify {
+    YGJustifyFlexStart = 0,
+    YGJustifyCenter = 1,
+    YGJustifyFlexEnd = 2,
+    YGJustifySpaceBetween = 3,
+    YGJustifySpaceAround = 4,
+    YGJustifySpaceEvenly = 5,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGOverflow {
+    YGOverflowVisible = 0,
+    YGOverflowHidden = 1,
+    YGOverflowScroll = 2,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGPositionType {
+    YGPositionTypeStatic = 0,
+    YGPositionTypeRelative = 1,
+    YGPositionTypeAbsolute = 2,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGUnit {
+    YGUnitUndefined = 0,
+    YGUnitPoint = 1,
+    YGUnitPercent = 2,
+    YGUnitAuto = 3,
+    UNRECOGNIZED = -1
+}
+
+declare enum YGWrap {
+    YGWrapNoWrap = 0,
+    YGWrapWrap = 1,
+    YGWrapWrapReverse = 2,
+    UNRECOGNIZED = -1
+}
+
 export { }