Merge branch 'main' into feat/abgen-preview

Author: dalkia

package-lock.json

@@ -6,7 +6,7 @@
   "bugs": "https://github.com/decentraland/js-sdk-toolchain/issues",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@dcl/protocol": "1.0.0-29286492043.commit-0010e70",
+    "@dcl/protocol": "1.0.0-30373157983.commit-2c475cb",
     "@dcl/quickjs-emscripten": "^0.21.0-3680274614.commit-1808aa1",
     "@dcl/ts-proto": "1.153.0",
     "@types/fs-extra": "^9.0.12",

package.json

@@ -0,0 +1,113 @@
+import { Entity, IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine'
+import { TouchScreenControls, PBTouchScreenControls, PBTouchScreenControls_TouchInput } from '../generated/index.gen'
+import { InputAction } from '../generated/pb/decentraland/sdk/components/common/input_action.gen'
+
+const ROOT_ENTITY = 0 as Entity
+
+// Every on-screen gamepad action button.
+const ALL_BUTTONS: InputAction[] = [
+  InputAction.IA_POINTER,
+  InputAction.IA_PRIMARY,
+  InputAction.IA_SECONDARY,
+  InputAction.IA_JUMP,
+  InputAction.IA_ACTION_3,
+  InputAction.IA_ACTION_4,
+  InputAction.IA_ACTION_5,
+  InputAction.IA_ACTION_6
+]
+
+/**
+ * @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 button hide list).
+   * Does NOT change the joystick/crosshair — use `showJoystick()` / `showCrosshair()` for those.
+   */
+  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
+  /** Show the native virtual joystick. */
+  showJoystick(): void
+  /** Hide the on-screen crosshair / reticle. */
+  hideCrosshair(): void
+  /** Show the on-screen crosshair / reticle. */
+  showCrosshair(): void
+}
+
+export function defineTouchScreenControlsComponent(
+  engine: Pick<IEngine, 'defineComponentFromSchema'>
+): TouchScreenControlsComponentDefinitionExtended {
+  const theComponent = TouchScreenControls(engine)
+
+  // A mutable copy of the current RootEntity value (or a fresh default).
+  function current(): PBTouchScreenControls {
+    const value = theComponent.getOrNull(ROOT_ENTITY)
+    return {
+      touchInputs: value?.touchInputs
+        ? value.touchInputs.map((t) => ({ ...t, icon: t.icon ? { ...t.icon } : t.icon }))
+        : [],
+      mainAction: value?.mainAction,
+      hideJoystick: value?.hideJoystick ?? false,
+      hideCrosshair: value?.hideCrosshair ?? false
+    }
+  }
+
+  function setHidden(actions: InputAction[]): void {
+    const value = current()
+    const byAction = new Map<InputAction, PBTouchScreenControls_TouchInput>()
+    for (const input of value.touchInputs) byAction.set(input.inputAction, input)
+    for (const action of actions) byAction.set(action, { ...byAction.get(action), inputAction: action, hide: true })
+    value.touchInputs = [...byAction.values()]
+    theComponent.createOrReplace(ROOT_ENTITY, value)
+  }
+
+  return {
+    ...theComponent,
+    hideAll(): void {
+      setHidden(ALL_BUTTONS)
+    },
+    showAll(): void {
+      const value = current()
+      value.touchInputs = []
+      theComponent.createOrReplace(ROOT_ENTITY, value)
+    },
+    hide(actions: InputAction[]): void {
+      setHidden(actions)
+    },
+    setMainAction(action: InputAction): void {
+      const value = current()
+      value.mainAction = action
+      theComponent.createOrReplace(ROOT_ENTITY, value)
+    },
+    hideJoystick(): void {
+      const value = current()
+      value.hideJoystick = true
+      theComponent.createOrReplace(ROOT_ENTITY, value)
+    },
+    showJoystick(): void {
+      const value = current()
+      value.hideJoystick = false
+      theComponent.createOrReplace(ROOT_ENTITY, value)
+    },
+    hideCrosshair(): void {
+      const value = current()
+      value.hideCrosshair = true
+      theComponent.createOrReplace(ROOT_ENTITY, value)
+    },
+    showCrosshair(): void {
+      const value = current()
+      value.hideCrosshair = false
+      theComponent.createOrReplace(ROOT_ENTITY, value)
+    }
+  }
+}

packages/@dcl/ecs/src/components/extended/TouchScreenControls.ts

@@ -21,6 +21,10 @@ import { defineInputModifierComponent, InputModifierComponentDefinitionExtended
 import { defineLightSourceComponent, LightSourceComponentDefinitionExtended } from './extended/LightSource'
 import { defineTriggerAreaComponent, TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea'
 import { defineParticleSystemComponent, ParticleSystemComponentDefinitionExtended } from './extended/ParticleSystem'
+import {
+  defineTouchScreenControlsComponent,
+  TouchScreenControlsComponentDefinitionExtended
+} from './extended/TouchScreenControls'
 import defineTagsComponent, { TagsComponentDefinitionExtended } from './manual/Tags'
 
 export * from './generated/index.gen'
@@ -87,6 +91,10 @@ export const TriggerArea: LwwComponentGetter<TriggerAreaComponentDefinitionExten
 export const ParticleSystem: LwwComponentGetter<ParticleSystemComponentDefinitionExtended> = (engine) =>
   defineParticleSystemComponent(engine)
 
+/* @__PURE__ */
+export const TouchScreenControls: LwwComponentGetter<TouchScreenControlsComponentDefinitionExtended> = (engine) =>
+  defineTouchScreenControlsComponent(engine)
+
 /**
  * @alpha
  */

packages/@dcl/ecs/src/components/index.ts

@@ -28,6 +28,7 @@ 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,

packages/@dcl/ecs/src/components/types.ts

@@ -41,7 +41,8 @@ import {
   InputModifierComponentDefinitionExtended,
   LightSourceComponentDefinitionExtended,
   TriggerAreaComponentDefinitionExtended,
-  ParticleSystemComponentDefinitionExtended
+  ParticleSystemComponentDefinitionExtended,
+  TouchScreenControlsComponentDefinitionExtended
 } from './components/types'
 import { NameComponent } from './components/manual/Name'
 import { TagsComponentDefinitionExtended } from './components/manual/Tags'
@@ -64,6 +65,8 @@ export const LightSource: LightSourceComponentDefinitionExtended = /* @__PURE__*
 export const TriggerArea: TriggerAreaComponentDefinitionExtended = /* @__PURE__*/ components.TriggerArea(engine)
 export const ParticleSystem: ParticleSystemComponentDefinitionExtended =
   /* @__PURE__*/ components.ParticleSystem(engine)
+export const TouchScreenControls: TouchScreenControlsComponentDefinitionExtended =
+  /* @__PURE__*/ components.TouchScreenControls(engine)
 
 /**
  * @alpha

packages/@dcl/ecs/src/index.ts

@@ -732,6 +732,7 @@ export const componentDefinitionByName: {
     "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
     "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
+    "core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
     "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
     "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
     "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
@@ -742,6 +743,7 @@ export const componentDefinitionByName: {
     "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
     "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
     "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
+    "core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
     "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
     "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
     "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
@@ -1185,6 +1187,7 @@ export type EntityComponents = {
     uiBackground: PBUiBackground;
     uiInput: PBUiInput;
     uiDropdown: PBUiDropdown;
+    uiInputBinding: PBUiInputBinding;
     onMouseDown: Callback;
     onMouseUp: Callback;
     onMouseEnter: Callback;
@@ -1205,6 +1208,7 @@ export enum EntityMappingMode {
 export interface EntityPropTypes extends Listeners {
     key?: Key;
     uiBackground?: UiBackgroundProps;
+    uiInputBinding?: PBUiInputBinding;
     uiTransform?: UiTransformProps;
 }
 
@@ -3604,6 +3608,38 @@ export namespace PBTextShape {
     export function encode(message: PBTextShape, writer?: _m0.Writer): _m0.Writer;
 }
 
+// @public (undocumented)
+export interface PBTouchScreenControls {
+    hideCrosshair: boolean;
+    hideJoystick: boolean;
+    mainAction?: InputAction | undefined;
+    // (undocumented)
+    touchInputs: PBTouchScreenControls_TouchInput[];
+}
+
+// @public (undocumented)
+export namespace PBTouchScreenControls {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls;
+    // (undocumented)
+    export function encode(message: PBTouchScreenControls, writer?: _m0.Writer): _m0.Writer;
+}
+
+// @public (undocumented)
+export interface PBTouchScreenControls_TouchInput {
+    hide: boolean;
+    icon?: TextureUnion | undefined;
+    inputAction: InputAction;
+}
+
+// @public (undocumented)
+export namespace PBTouchScreenControls_TouchInput {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls_TouchInput;
+    // (undocumented)
+    export function encode(message: PBTouchScreenControls_TouchInput, writer?: _m0.Writer): _m0.Writer;
+}
+
 // @public (undocumented)
 export interface PBTriggerArea {
     collisionMask?: number | undefined;
@@ -3826,6 +3862,19 @@ export namespace PBUiInput {
     export function encode(message: PBUiInput, writer?: _m0.Writer): _m0.Writer;
 }
 
+// @public (undocumented)
+export interface PBUiInputBinding {
+    actions: InputAction[];
+}
+
+// @public (undocumented)
+export namespace PBUiInputBinding {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputBinding;
+    // (undocumented)
+    export function encode(message: PBUiInputBinding, writer?: _m0.Writer): _m0.Writer;
+}
+
 // @public (undocumented)
 export interface PBUiInputResult {
     isSubmit?: boolean | undefined;
@@ -4057,6 +4106,7 @@ export namespace PBVideoPlayer {
 export interface PBVirtualCamera {
     // (undocumented)
     defaultTransition?: CameraTransition | undefined;
+    fov?: number | undefined;
     // (undocumented)
     lookAtEntity?: number | undefined;
 }
@@ -5055,6 +5105,23 @@ export const ToLinearSpace = 2.2;
 // @public (undocumented)
 export type ToOptional<T> = OnlyOptionalUndefinedTypes<T> & OnlyNonUndefinedTypes<T>;
 
+// Warning: (ae-missing-release-tag) "TouchScreenControls" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const TouchScreenControls: TouchScreenControlsComponentDefinitionExtended;
+
+// @public
+export interface TouchScreenControlsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTouchScreenControls> {
+    hide(actions: InputAction[]): void;
+    hideAll(): void;
+    hideCrosshair(): void;
+    hideJoystick(): void;
+    setMainAction(action: InputAction): void;
+    showAll(): void;
+    showCrosshair(): void;
+    showJoystick(): void;
+}
+
 // Warning: (ae-missing-release-tag) "Transform" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -5300,6 +5367,9 @@ export type UiFontType = 'sans-serif' | 'serif' | 'monospace';
 // @public (undocumented)
 export const UiInput: LastWriteWinElementSetComponentDefinition<PBUiInput>;
 
+// @public (undocumented)
+export const UiInputBinding: LastWriteWinElementSetComponentDefinition<PBUiInputBinding>;
+
 // @public (undocumented)
 export interface UiInputProps extends Omit<PBUiInput, 'font' | 'textAlign' | 'fontSize'> {
     // (undocumented)

packages/@dcl/playground-assets/etc/playground-assets.api.md

@@ -1,3 +1,4 @@
+import { PBUiInputBinding } from '@dcl/ecs'
 import { ReactEcs } from '../react-ecs'
 import { Listeners } from './listeners/types'
 import { UiBackgroundProps } from './uiBackground/types'
@@ -12,6 +13,8 @@ export interface EntityPropTypes extends Listeners {
   uiTransform?: UiTransformProps
   /** To define a background color or image */
   uiBackground?: UiBackgroundProps
+  /** Bind input actions to this element, held down while it's pressed (touch or pointer) */
+  uiInputBinding?: PBUiInputBinding
   /** Uinique key to identiy elments when iterating arrays */
   key?: Key
 }

packages/@dcl/react-ecs/src/components/types.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
-import { PBUiBackground, PBUiText, PBUiTransform, PBUiInput, PBUiDropdown } from '@dcl/ecs'
+import { PBUiBackground, PBUiText, PBUiTransform, PBUiInput, PBUiDropdown, PBUiInputBinding } from '@dcl/ecs'
 import React from 'react'
 import { Callback, Key } from './components'
 
@@ -19,6 +19,7 @@ export type EntityComponents = {
   uiBackground: PBUiBackground
   uiInput: PBUiInput
   uiDropdown: PBUiDropdown
+  uiInputBinding: PBUiInputBinding
   onMouseDown: Callback
   onMouseUp: Callback
   onMouseEnter: Callback

packages/@dcl/react-ecs/src/react-ecs.ts

@@ -71,6 +71,7 @@ export function createReconciler(
   const UiInputResult = components.UiInputResult(engine)
   const UiDropdown = components.UiDropdown(engine)
   const UiDropdownResult = components.UiDropdownResult(engine)
+  const UiInputBinding = components.UiInputBinding(engine)
 
   // Component ID Helper
   const getComponentId: {
@@ -80,7 +81,8 @@ export function createReconciler(
     uiText: UiText.componentId,
     uiBackground: UiBackground.componentId,
     uiInput: UiInput.componentId,
-    uiDropdown: UiDropdown.componentId
+    uiDropdown: UiDropdown.componentId,
+    uiInputBinding: UiInputBinding.componentId
   }
 
   function pointerEventCallback(entity: Entity, pointerEvent: PointerEventType) {