@dcl/sdk 7.0.0-3008112906.commit-524d1bd → 7.0.0-3039764556.commit-d9e186e

package/dist/ecs7/index.d.ts

@@ -247,14 +247,24 @@ export declare namespace Components {
     /** @public */
     const PlaneShape: ComponentDefinition<ISchema<PBPlaneShape>, PBPlaneShape>;
     /** @public */
+    const PointerEvents: ComponentDefinition<ISchema<PBPointerEvents>, PBPointerEvents>;
+    /** @public */
+    const PointerEventsResult: ComponentDefinition<ISchema<PBPointerEventsResult>, PBPointerEventsResult>;
+    /** @public */
     const PointerLock: ComponentDefinition<ISchema<PBPointerLock>, PBPointerLock>;
     /** @public */
+    const Raycast: ComponentDefinition<ISchema<PBRaycast>, PBRaycast>;
+    /** @public */
+    const RaycastResult: ComponentDefinition<ISchema<PBRaycastResult>, PBRaycastResult>;
+    /** @public */
     const SphereShape: ComponentDefinition<ISchema<PBSphereShape>, PBSphereShape>;
     /** @public */
     const TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
     /** @public */
     const UiText: ComponentDefinition<ISchema<PBUiText>, PBUiText>;
     /** @public */
+    const UiTransform: ComponentDefinition<ISchema<PBUiTransform>, PBUiTransform>;
+    /** @public */
     const VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 }
 
@@ -480,10 +490,15 @@ declare function defineSdkComponents(engine: PreEngine): {
     OnPointerUp: ComponentDefinition<ISchema<PBOnPointerUp>, PBOnPointerUp>;
     OnPointerUpResult: ComponentDefinition<ISchema<PBOnPointerUpResult>, PBOnPointerUpResult>;
     PlaneShape: ComponentDefinition<ISchema<PBPlaneShape>, PBPlaneShape>;
+    PointerEvents: ComponentDefinition<ISchema<PBPointerEvents>, PBPointerEvents>;
+    PointerEventsResult: ComponentDefinition<ISchema<PBPointerEventsResult>, PBPointerEventsResult>;
     PointerLock: ComponentDefinition<ISchema<PBPointerLock>, PBPointerLock>;
+    Raycast: ComponentDefinition<ISchema<PBRaycast>, PBRaycast>;
+    RaycastResult: ComponentDefinition<ISchema<PBRaycastResult>, PBRaycastResult>;
     SphereShape: ComponentDefinition<ISchema<PBSphereShape>, PBSphereShape>;
     TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
     UiText: ComponentDefinition<ISchema<PBUiText>, PBUiText>;
+    UiTransform: ComponentDefinition<ISchema<PBUiTransform>, PBUiTransform>;
     VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 };
 
@@ -587,13 +602,13 @@ export declare type IEngine = {
      * engine.addSystem(mySystem, 10)
      * ```
      */
-    addSystem(system: Update, priority?: number, name?: string): void;
+    addSystem(system: SystemFn, priority?: number, name?: string): void;
     /**
      * Remove a system from the engine.
      * @param selector the function or the unique name to identify
      * @returns if it was found and removed
      */
-    removeSystem(selector: string | Update): boolean;
+    removeSystem(selector: string | SystemFn): boolean;
     /**
      * Define a component and add it to the engine.
      * @param spec An object with schema fields
@@ -610,7 +625,7 @@ export declare type IEngine = {
      *
      * ```
      */
-    defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: Partial<Result<T>>): ComponentDefinition<ISchema<Result<T>>, ConstructorType>;
+    defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: ConstructorType): ComponentDefinition<ISchema<Result<T>>, Partial<Result<T>>>;
     /**
      * Define a component and add it to the engine.
      * @param spec An object with schema fields
@@ -646,6 +661,7 @@ export declare type IEngine = {
      * ```
      */
     getEntitiesWith<T extends [ComponentDefinition, ...ComponentDefinition[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
+    RootEntity: Entity;
     baseComponents: SdkComponents;
 };
 
@@ -700,6 +716,17 @@ export declare interface ISize {
     height: number;
 }
 
+/**
+ * Check if a pointer event has been emited in the last tick-update.
+ * @param entity the entity to query, for global clicks use `engine.RootEntity`
+ * @param actionButton
+ * @param pointerEventType
+ * @returns
+ */
+export declare function isPointerEventActive(entity: Entity, actionButton: ActionButton, pointerEventType: PointerEventType): boolean;
+
+export declare function isPointerEventActiveGenerator(engine: IEngine): (entity: Entity, actionButton: ActionButton, pointerEventType: PointerEventType) => boolean;
+
 export declare const log: (...a: any[]) => void;
 
 /** @public */
@@ -2072,10 +2099,63 @@ declare interface PBPlaneShape {
     uvs: number[];
 }
 
+declare interface PBPointerEvents {
+    pointerEvents: PBPointerEvents_Entry[];
+}
+
+declare interface PBPointerEvents_Entry {
+    eventType: PointerEventType;
+    eventInfo: PBPointerEvents_Info | undefined;
+}
+
+declare interface PBPointerEvents_Info {
+    /** default=ActionButton.ANY */
+    button?: ActionButton | undefined;
+    /** default='Interact' */
+    hoverText?: string | undefined;
+    /** default=10 */
+    maxDistance?: number | undefined;
+    /** default=true */
+    showFeedback?: boolean | undefined;
+}
+
+/** the renderer will set this component to the root entity once per frame with all the events */
+declare interface PBPointerEventsResult {
+    /** a list of the last N pointer commands (from the engine) */
+    commands: PBPointerEventsResult_PointerCommand[];
+}
+
+/** this message represents a pointer event, used both for UP and DOWN actions */
+declare interface PBPointerEventsResult_PointerCommand {
+    /** identifier of the input */
+    button: ActionButton;
+    hit: RaycastHit | undefined;
+    state: PointerEventType;
+    /** could be a Lamport timestamp */
+    timestamp: number;
+    /** if the input is analog then we store it here */
+    analog?: number | undefined;
+}
+
 declare interface PBPointerLock {
     isPointerLocked: boolean;
 }
 
+declare interface PBRaycast {
+    timestamp: number;
+    origin: Vector3_2 | undefined;
+    direction: Vector3_2 | undefined;
+    maxDistance: number;
+    queryType: RaycastQueryType;
+}
+
+declare interface PBRaycastResult {
+    timestamp: number;
+    origin: Vector3_2 | undefined;
+    direction: Vector3_2 | undefined;
+    hits: RaycastHit[];
+}
+
 declare interface PBSphereShape {
     /** @deprecated use MeshCollider instead https://github.com/decentraland/sdk/issues/366 */
     withCollisions?: boolean | undefined;
@@ -2127,6 +2207,67 @@ declare interface PBUiText {
     textColor: Color3 | undefined;
 }
 
+declare interface PBUiTransform {
+    parent: number;
+    rightOf: number;
+    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;
+}
+
 declare interface PBVisibilityComponent {
     /** default=true */
     visible?: boolean | undefined;
@@ -2244,6 +2385,20 @@ declare namespace Plane {
 /** @public */
 export declare const PlaneShape: ComponentDefinition<ISchema<PBPlaneShape>, PBPlaneShape>;
 
+/** @public */
+export declare const PointerEvents: ComponentDefinition<ISchema<PBPointerEvents>, PBPointerEvents>;
+
+/** @public */
+export declare const PointerEventsResult: ComponentDefinition<ISchema<PBPointerEventsResult>, PBPointerEventsResult>;
+
+declare const enum PointerEventType {
+    UP = 0,
+    DOWN = 1,
+    HOVER_ENTER = 2,
+    HOVER_LEAVE = 3,
+    UNRECOGNIZED = -1
+}
+
 /** @public */
 export declare const PointerLock: ComponentDefinition<ISchema<PBPointerLock>, PBPointerLock>;
 
@@ -2258,13 +2413,13 @@ declare function preEngine(): {
     addEntity: (dynamic?: boolean) => Entity;
     addDynamicEntity: () => Entity;
     removeEntity: (entity: Entity) => boolean;
-    addSystem: (fn: Update, priority?: number, name?: string | undefined) => void;
+    addSystem: (fn: SystemFn, priority?: number, name?: string | undefined) => void;
     getSystems: () => {
-        fn: Update;
+        fn: SystemFn;
         priority: number;
         name?: string | undefined;
     }[];
-    removeSystem: (selector: string | Update) => boolean;
+    removeSystem: (selector: string | SystemFn) => boolean;
     defineComponent: <T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: ConstructorType | undefined) => ComponentDefinition<ISchema<Result<T>>, ConstructorType>;
     defineComponentFromSchema: <T_1 extends ISchema<any>, ConstructorType_1 = EcsResult<T_1>>(spec: T_1, componentId: number, constructorDefault?: ConstructorType_1 | undefined) => ComponentDefinition<T_1, ConstructorType_1>;
     getEntitiesWith: <T_2 extends [ComponentDefinition<ISchema<any>, any>, ...ComponentDefinition<ISchema<any>, any>[]]>(...components: T_2) => Iterable<[Entity, ...ReadonlyComponentSchema<T_2>]>;
@@ -2442,6 +2597,29 @@ export declare namespace Quaternion {
  */
 export declare const RAD2DEG: number;
 
+/** @public */
+export declare const Raycast: ComponentDefinition<ISchema<PBRaycast>, PBRaycast>;
+
+/** Position will be relative to the scene */
+declare interface RaycastHit {
+    position: Vector3_2 | undefined;
+    origin: Vector3_2 | undefined;
+    direction: Vector3_2 | undefined;
+    normalHit: Vector3_2 | undefined;
+    length: number;
+    meshName?: string | undefined;
+    entityId?: number | undefined;
+}
+
+declare const enum RaycastQueryType {
+    HIT_FIRST = 0,
+    QUERY_ALL = 1,
+    UNRECOGNIZED = -1
+}
+
+/** @public */
+export declare const RaycastResult: ComponentDefinition<ISchema<PBRaycastResult>, PBRaycastResult>;
+
 /**
  * @public
  */
@@ -2519,6 +2697,11 @@ export declare interface Spec {
 /** @public */
 export declare const SphereShape: ComponentDefinition<ISchema<PBSphereShape>, PBSphereShape>;
 
+/**
+ * @public
+ */
+export declare type SystemFn = (dt: number) => void;
+
 /** @public */
 export declare const TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
 
@@ -2593,15 +2776,13 @@ declare type Uint32 = number;
 /** @public */
 export declare const UiText: ComponentDefinition<ISchema<PBUiText>, PBUiText>;
 
-/**
- * @public
- */
-export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
+/** @public */
+export declare const UiTransform: ComponentDefinition<ISchema<PBUiTransform>, PBUiTransform>;
 
 /**
  * @public
  */
-export declare type Update = (dt: number) => void;
+export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
 
 /**
  * @public
@@ -2815,6 +2996,16 @@ declare interface Vector3_2 {
 /** @public */
 export declare const VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 
+/**
+ * Check if an entity emitted a clicked event
+ * @param entity the entity to query, for global clicks use `engine.RootEntity`
+ * @param actionButton
+ * @returns true if the entity was clicked in the last tick-update
+ */
+export declare function wasEntityClicked(entity: Entity, actionButton: ActionButton): boolean;
+
+export declare function wasEntityClickedGenerator(engine: IEngine): (entity: Entity, actionButton: ActionButton) => boolean;
+
 declare namespace WireMessage {
     enum Enum {
         RESERVED = 0,
@@ -2839,4 +3030,76 @@ declare namespace WireMessage {
     function readHeader(buf: ByteBuffer): Header | null;
 }
 
+declare const enum YGAlign {
+    YGAlignAuto = 0,
+    YGAlignFlexStart = 1,
+    YGAlignCenter = 2,
+    YGAlignFlexEnd = 3,
+    YGAlignStretch = 4,
+    YGAlignBaseline = 5,
+    YGAlignSpaceBetween = 6,
+    YGAlignSpaceAround = 7,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGDirection {
+    YGDirectionInherit = 0,
+    YGDirectionLTR = 1,
+    YGDirectionRTL = 2,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGDisplay {
+    YGDisplayFlex = 0,
+    YGDisplayNone = 1,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGFlexDirection {
+    YGFlexDirectionColumn = 0,
+    YGFlexDirectionColumnReverse = 1,
+    YGFlexDirectionRow = 2,
+    YGFlexDirectionRowReverse = 3,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGJustify {
+    YGJustifyFlexStart = 0,
+    YGJustifyCenter = 1,
+    YGJustifyFlexEnd = 2,
+    YGJustifySpaceBetween = 3,
+    YGJustifySpaceAround = 4,
+    YGJustifySpaceEvenly = 5,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGOverflow {
+    YGOverflowVisible = 0,
+    YGOverflowHidden = 1,
+    YGOverflowScroll = 2,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGPositionType {
+    YGPositionTypeStatic = 0,
+    YGPositionTypeRelative = 1,
+    YGPositionTypeAbsolute = 2,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGUnit {
+    YGUnitUndefined = 0,
+    YGUnitPoint = 1,
+    YGUnitPercent = 2,
+    YGUnitAuto = 3,
+    UNRECOGNIZED = -1
+}
+
+declare const enum YGWrap {
+    YGWrapNoWrap = 0,
+    YGWrapWrap = 1,
+    YGWrapWrapReverse = 2,
+    UNRECOGNIZED = -1
+}
+
 export { }