@dcl/ecs 7.25.1-30391610123.commit-26cb925 → 7.25.1-30540108605.commit-82368ee

package/dist/components/extended/TouchScreenControls.d.ts

@@ -0,0 +1,23 @@
+import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine';
+import { PBTouchScreenControls } from '../generated/index.gen';
+import { InputAction } from '../generated/pb/decentraland/sdk/components/common/input_action.gen';
+/**
+ * @public
+ * TouchScreenControls with convenience helpers. All helpers write the component onto the
+ * RootEntity (where the client reads it) and merge with the current value.
+ */
+export interface TouchScreenControlsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTouchScreenControls> {
+    /** Hide every on-screen gamepad button. */
+    hideAll(): void;
+    /** Show every on-screen gamepad button (clears the hide list). */
+    showAll(): void;
+    /** Hide the given on-screen buttons (merged into the current config). */
+    hide(actions: InputAction[]): void;
+    /** Set which action the large central button triggers. */
+    setMainAction(action: InputAction): void;
+    /** Hide the native virtual joystick. */
+    hideJoystick(): void;
+    /** Hide the on-screen crosshair / reticle. */
+    hideCrosshair(): void;
+}
+export declare function defineTouchScreenControlsComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): TouchScreenControlsComponentDefinitionExtended;

package/dist/components/extended/TouchScreenControls.js

@@ -0,0 +1,65 @@
+import { TouchScreenControls } from '../generated/index.gen';
+const ROOT_ENTITY = 0;
+// Every on-screen gamepad action button.
+const ALL_BUTTONS = [
+    0 /* InputAction.IA_POINTER */,
+    1 /* InputAction.IA_PRIMARY */,
+    2 /* InputAction.IA_SECONDARY */,
+    8 /* InputAction.IA_JUMP */,
+    10 /* InputAction.IA_ACTION_3 */,
+    11 /* InputAction.IA_ACTION_4 */,
+    12 /* InputAction.IA_ACTION_5 */,
+    13 /* InputAction.IA_ACTION_6 */
+];
+export function defineTouchScreenControlsComponent(engine) {
+    const theComponent = TouchScreenControls(engine);
+    // A mutable copy of the current RootEntity value (or a fresh default).
+    function current() {
+        const value = theComponent.getOrNull(ROOT_ENTITY);
+        return {
+            touchInputs: value?.touchInputs ? value.touchInputs.map((t) => ({ ...t })) : [],
+            mainAction: value?.mainAction,
+            hideJoystick: value?.hideJoystick ?? false,
+            hideCrosshair: value?.hideCrosshair ?? false
+        };
+    }
+    function setHidden(actions) {
+        const value = current();
+        const byAction = new Map();
+        for (const input of value.touchInputs)
+            byAction.set(input.inputAction, input);
+        for (const action of actions)
+            byAction.set(action, { inputAction: action, hide: true });
+        value.touchInputs = [...byAction.values()];
+        theComponent.createOrReplace(ROOT_ENTITY, value);
+    }
+    return {
+        ...theComponent,
+        hideAll() {
+            setHidden(ALL_BUTTONS);
+        },
+        showAll() {
+            const value = current();
+            value.touchInputs = [];
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        },
+        hide(actions) {
+            setHidden(actions);
+        },
+        setMainAction(action) {
+            const value = current();
+            value.mainAction = action;
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        },
+        hideJoystick() {
+            const value = current();
+            value.hideJoystick = true;
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        },
+        hideCrosshair() {
+            const value = current();
+            value.hideCrosshair = true;
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        }
+    };
+}

package/dist/components/index.d.ts

@@ -21,6 +21,7 @@ import { InputModifierComponentDefinitionExtended } from './extended/InputModifi
 import { LightSourceComponentDefinitionExtended } from './extended/LightSource';
 import { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
 import { ParticleSystemComponentDefinitionExtended } from './extended/ParticleSystem';
+import { TouchScreenControlsComponentDefinitionExtended } from './extended/TouchScreenControls';
 import { TagsComponentDefinitionExtended } from './manual/Tags';
 export * from './generated/index.gen';
 export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition, LwwComponentGetter, GSetComponentGetter };
@@ -38,6 +39,7 @@ export declare const InputModifier: LwwComponentGetter<InputModifierComponentDef
 export declare const LightSource: LwwComponentGetter<LightSourceComponentDefinitionExtended>;
 export declare const TriggerArea: LwwComponentGetter<TriggerAreaComponentDefinitionExtended>;
 export declare const ParticleSystem: LwwComponentGetter<ParticleSystemComponentDefinitionExtended>;
+export declare const TouchScreenControls: LwwComponentGetter<TouchScreenControlsComponentDefinitionExtended>;
 /**
  * @alpha
  */

package/dist/components/index.js

@@ -17,6 +17,7 @@ import { defineInputModifierComponent } from './extended/InputModifier';
 import { defineLightSourceComponent } from './extended/LightSource';
 import { defineTriggerAreaComponent } from './extended/TriggerArea';
 import { defineParticleSystemComponent } from './extended/ParticleSystem';
+import { defineTouchScreenControlsComponent } from './extended/TouchScreenControls';
 import defineTagsComponent from './manual/Tags';
 export * from './generated/index.gen';
 /* @__PURE__ */
@@ -47,6 +48,8 @@ export const LightSource = (engine) => defineLightSourceComponent(engine);
 export const TriggerArea = (engine) => defineTriggerAreaComponent(engine);
 /* @__PURE__ */
 export const ParticleSystem = (engine) => defineParticleSystemComponent(engine);
+/* @__PURE__ */
+export const TouchScreenControls = (engine) => defineTouchScreenControlsComponent(engine);
 /**
  * @alpha
  */

package/dist/components/types.d.ts

@@ -16,4 +16,5 @@ export type { INetowrkParent, INetowrkParentType } from './manual/NetworkParent'
 export type { InputModifierHelper, InputModifierComponentDefinitionExtended } from './extended/InputModifier';
 export type { LightSourceHelper, LightSourceComponentDefinitionExtended } from './extended/LightSource';
 export type { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
+export type { TouchScreenControlsComponentDefinitionExtended } from './extended/TouchScreenControls';
 export type { ParticleSystemHelper, ParticleSystemComponentDefinitionExtended, ParticleSystemBlendMode, ParticleSystemPlaybackState } from './extended/ParticleSystem';

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export * from './systems/triggerArea';
 export * from './systems/physics';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, TouchScreenControlsComponentDefinitionExtended } from './components/types';
 import { NameComponent } from './components/manual/Name';
 import { TagsComponentDefinitionExtended } from './components/manual/Tags';
 export declare const Transform: TransformComponentExtended;
@@ -34,6 +34,7 @@ export declare const InputModifier: InputModifierComponentDefinitionExtended;
 export declare const LightSource: LightSourceComponentDefinitionExtended;
 export declare const TriggerArea: TriggerAreaComponentDefinitionExtended;
 export declare const ParticleSystem: ParticleSystemComponentDefinitionExtended;
+export declare const TouchScreenControls: TouchScreenControlsComponentDefinitionExtended;
 /**
  * @alpha
  * This is going to be used for sync components through a server.

package/dist/index.js

@@ -39,6 +39,8 @@ export const LightSource = /* @__PURE__*/ components.LightSource(engine);
 export const TriggerArea = /* @__PURE__*/ components.TriggerArea(engine);
 export const ParticleSystem = 
 /* @__PURE__*/ components.ParticleSystem(engine);
+export const TouchScreenControls = 
+/* @__PURE__*/ components.TouchScreenControls(engine);
 /**
  * @alpha
  * This is going to be used for sync components through a server.

package/dist-cjs/components/extended/TouchScreenControls.d.ts

@@ -0,0 +1,23 @@
+import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine';
+import { PBTouchScreenControls } from '../generated/index.gen';
+import { InputAction } from '../generated/pb/decentraland/sdk/components/common/input_action.gen';
+/**
+ * @public
+ * TouchScreenControls with convenience helpers. All helpers write the component onto the
+ * RootEntity (where the client reads it) and merge with the current value.
+ */
+export interface TouchScreenControlsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTouchScreenControls> {
+    /** Hide every on-screen gamepad button. */
+    hideAll(): void;
+    /** Show every on-screen gamepad button (clears the hide list). */
+    showAll(): void;
+    /** Hide the given on-screen buttons (merged into the current config). */
+    hide(actions: InputAction[]): void;
+    /** Set which action the large central button triggers. */
+    setMainAction(action: InputAction): void;
+    /** Hide the native virtual joystick. */
+    hideJoystick(): void;
+    /** Hide the on-screen crosshair / reticle. */
+    hideCrosshair(): void;
+}
+export declare function defineTouchScreenControlsComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): TouchScreenControlsComponentDefinitionExtended;

package/dist-cjs/components/extended/TouchScreenControls.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineTouchScreenControlsComponent = void 0;
+const index_gen_1 = require("../generated/index.gen");
+const ROOT_ENTITY = 0;
+// Every on-screen gamepad action button.
+const ALL_BUTTONS = [
+    0 /* InputAction.IA_POINTER */,
+    1 /* InputAction.IA_PRIMARY */,
+    2 /* InputAction.IA_SECONDARY */,
+    8 /* InputAction.IA_JUMP */,
+    10 /* InputAction.IA_ACTION_3 */,
+    11 /* InputAction.IA_ACTION_4 */,
+    12 /* InputAction.IA_ACTION_5 */,
+    13 /* InputAction.IA_ACTION_6 */
+];
+function defineTouchScreenControlsComponent(engine) {
+    const theComponent = (0, index_gen_1.TouchScreenControls)(engine);
+    // A mutable copy of the current RootEntity value (or a fresh default).
+    function current() {
+        const value = theComponent.getOrNull(ROOT_ENTITY);
+        return {
+            touchInputs: value?.touchInputs ? value.touchInputs.map((t) => ({ ...t })) : [],
+            mainAction: value?.mainAction,
+            hideJoystick: value?.hideJoystick ?? false,
+            hideCrosshair: value?.hideCrosshair ?? false
+        };
+    }
+    function setHidden(actions) {
+        const value = current();
+        const byAction = new Map();
+        for (const input of value.touchInputs)
+            byAction.set(input.inputAction, input);
+        for (const action of actions)
+            byAction.set(action, { inputAction: action, hide: true });
+        value.touchInputs = [...byAction.values()];
+        theComponent.createOrReplace(ROOT_ENTITY, value);
+    }
+    return {
+        ...theComponent,
+        hideAll() {
+            setHidden(ALL_BUTTONS);
+        },
+        showAll() {
+            const value = current();
+            value.touchInputs = [];
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        },
+        hide(actions) {
+            setHidden(actions);
+        },
+        setMainAction(action) {
+            const value = current();
+            value.mainAction = action;
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        },
+        hideJoystick() {
+            const value = current();
+            value.hideJoystick = true;
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        },
+        hideCrosshair() {
+            const value = current();
+            value.hideCrosshair = true;
+            theComponent.createOrReplace(ROOT_ENTITY, value);
+        }
+    };
+}
+exports.defineTouchScreenControlsComponent = defineTouchScreenControlsComponent;

package/dist-cjs/components/index.d.ts

@@ -21,6 +21,7 @@ import { InputModifierComponentDefinitionExtended } from './extended/InputModifi
 import { LightSourceComponentDefinitionExtended } from './extended/LightSource';
 import { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
 import { ParticleSystemComponentDefinitionExtended } from './extended/ParticleSystem';
+import { TouchScreenControlsComponentDefinitionExtended } from './extended/TouchScreenControls';
 import { TagsComponentDefinitionExtended } from './manual/Tags';
 export * from './generated/index.gen';
 export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition, LwwComponentGetter, GSetComponentGetter };
@@ -38,6 +39,7 @@ export declare const InputModifier: LwwComponentGetter<InputModifierComponentDef
 export declare const LightSource: LwwComponentGetter<LightSourceComponentDefinitionExtended>;
 export declare const TriggerArea: LwwComponentGetter<TriggerAreaComponentDefinitionExtended>;
 export declare const ParticleSystem: LwwComponentGetter<ParticleSystemComponentDefinitionExtended>;
+export declare const TouchScreenControls: LwwComponentGetter<TouchScreenControlsComponentDefinitionExtended>;
 /**
  * @alpha
  */

package/dist-cjs/components/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MediaState = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Tags = exports.Name = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Material = exports.Transform = void 0;
+exports.MediaState = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Tags = exports.Name = exports.TouchScreenControls = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Material = exports.Transform = void 0;
 const Animator_1 = require("./extended/Animator");
 const AudioSource_1 = require("./extended/AudioSource");
 const AudioAnalysis_1 = require("./extended/AudioAnalysis");
@@ -38,6 +38,7 @@ const InputModifier_1 = require("./extended/InputModifier");
 const LightSource_1 = require("./extended/LightSource");
 const TriggerArea_1 = require("./extended/TriggerArea");
 const ParticleSystem_1 = require("./extended/ParticleSystem");
+const TouchScreenControls_1 = require("./extended/TouchScreenControls");
 const Tags_1 = __importDefault(require("./manual/Tags"));
 __exportStar(require("./generated/index.gen"), exports);
 /* @__PURE__ */
@@ -82,6 +83,9 @@ exports.TriggerArea = TriggerArea;
 /* @__PURE__ */
 const ParticleSystem = (engine) => (0, ParticleSystem_1.defineParticleSystemComponent)(engine);
 exports.ParticleSystem = ParticleSystem;
+/* @__PURE__ */
+const TouchScreenControls = (engine) => (0, TouchScreenControls_1.defineTouchScreenControlsComponent)(engine);
+exports.TouchScreenControls = TouchScreenControls;
 /**
  * @alpha
  */

package/dist-cjs/components/types.d.ts

@@ -16,4 +16,5 @@ export type { INetowrkParent, INetowrkParentType } from './manual/NetworkParent'
 export type { InputModifierHelper, InputModifierComponentDefinitionExtended } from './extended/InputModifier';
 export type { LightSourceHelper, LightSourceComponentDefinitionExtended } from './extended/LightSource';
 export type { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
+export type { TouchScreenControlsComponentDefinitionExtended } from './extended/TouchScreenControls';
 export type { ParticleSystemHelper, ParticleSystemComponentDefinitionExtended, ParticleSystemBlendMode, ParticleSystemPlaybackState } from './extended/ParticleSystem';

package/dist-cjs/index.d.ts

@@ -15,7 +15,7 @@ export * from './systems/triggerArea';
 export * from './systems/physics';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, TouchScreenControlsComponentDefinitionExtended } from './components/types';
 import { NameComponent } from './components/manual/Name';
 import { TagsComponentDefinitionExtended } from './components/manual/Tags';
 export declare const Transform: TransformComponentExtended;
@@ -34,6 +34,7 @@ export declare const InputModifier: InputModifierComponentDefinitionExtended;
 export declare const LightSource: LightSourceComponentDefinitionExtended;
 export declare const TriggerArea: TriggerAreaComponentDefinitionExtended;
 export declare const ParticleSystem: ParticleSystemComponentDefinitionExtended;
+export declare const TouchScreenControls: TouchScreenControlsComponentDefinitionExtended;
 /**
  * @alpha
  * This is going to be used for sync components through a server.

package/dist-cjs/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
+exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.TouchScreenControls = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
 // The order of the following imports matters. Please do not auto-sort
 __exportStar(require("./engine"), exports);
 __exportStar(require("./schemas"), exports);
@@ -68,6 +68,8 @@ exports.LightSource = components.LightSource(initialization_1.engine);
 exports.TriggerArea = components.TriggerArea(initialization_1.engine);
 exports.ParticleSystem = 
 /* @__PURE__*/ components.ParticleSystem(initialization_1.engine);
+exports.TouchScreenControls = 
+/* @__PURE__*/ components.TouchScreenControls(initialization_1.engine);
 /**
  * @alpha
  * This is going to be used for sync components through a server.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.25.1-30391610123.commit-26cb925",
+  "version": "7.25.1-30540108605.commit-82368ee",
   "author": "DCL",
   "bugs": "https://github.com/decentraland/ecs/issues",
   "files": [
@@ -34,5 +34,5 @@
   "dependencies": {},
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "26cb92516659d446b74945096eb4b7b48b7f06b1"
+  "commit": "82368ee4b5e23d192034e6880c9848a48515fc1e"
 }