@dcl/protocol 1.0.0-3338184295.commit-c785923 → 1.0.0-33408122230.commit-0e30273

package/out-ts/decentraland/sdk/components/touch_screen_controls.gen.ts

@@ -0,0 +1,265 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+import { TextureUnion } from "../../common/texture.gen";
+import { InputAction, inputActionFromJSON, inputActionToJSON } from "./common/input_action.gen";
+
+export const protobufPackage = "decentraland.sdk.components";
+
+/**
+ * The TouchScreenControls component lets a scene configure the native on-screen touch
+ * controls (the mobile joystick + gamepad). It must be set on the RootEntity.
+ *
+ * By default every on-screen button is shown; list a button in `touch_inputs` with
+ * `hide = true` to remove it (declutter). `main_action` picks which action the large
+ * central button triggers, and `hide_joystick` removes the native virtual joystick. It is
+ * a no-op on platforms without native on-screen controls (e.g. desktop).
+ *
+ * Accepted actions: only the on-screen gamepad actions map to a button — `IA_POINTER`,
+ * `IA_PRIMARY`, `IA_SECONDARY`, `IA_JUMP`, and `IA_ACTION_3`..`IA_ACTION_6`. Any other
+ * `InputAction` (movement actions, `IA_ANY`, `IA_MODIFIER`, or unknown/future values) is
+ * ignored: a `TouchInput` entry naming a non-button action has no effect, and a `main_action`
+ * that isn't a valid gamepad action falls back to the default central button (`IA_JUMP`).
+ */
+export interface PBTouchScreenControls {
+  touchInputs: PBTouchScreenControls_TouchInput[];
+  /**
+   * The large central button's action. Only the gamepad actions are valid:
+   * jump / pointer / primary (E) / secondary (F) / action_3..action_6 (1/2/3/4).
+   * When unset, the default central button (jump) is kept.
+   */
+  mainAction?:
+    | InputAction
+    | undefined;
+  /** hide the native virtual joystick */
+  hideJoystick: boolean;
+  /** hide the on-screen crosshair / reticle */
+  hideCrosshair: boolean;
+}
+
+/** Per-button configuration. A button not listed here keeps its default (shown). */
+export interface PBTouchScreenControls_TouchInput {
+  /** which on-screen button this configures */
+  inputAction: InputAction;
+  /** hide this button (default: shown) */
+  hide: boolean;
+  /**
+   * Override the button glyph with this texture. For the jump button it replaces all
+   * of its dynamic states (jump / double-jump / glide).
+   */
+  icon?: TextureUnion | undefined;
+}
+
+function createBasePBTouchScreenControls(): PBTouchScreenControls {
+  return { touchInputs: [], mainAction: undefined, hideJoystick: false, hideCrosshair: false };
+}
+
+export namespace PBTouchScreenControls {
+  export function encode(message: PBTouchScreenControls, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    for (const v of message.touchInputs) {
+      PBTouchScreenControls_TouchInput.encode(v!, writer.uint32(10).fork()).ldelim();
+    }
+    if (message.mainAction !== undefined) {
+      writer.uint32(16).int32(message.mainAction);
+    }
+    if (message.hideJoystick === true) {
+      writer.uint32(24).bool(message.hideJoystick);
+    }
+    if (message.hideCrosshair === true) {
+      writer.uint32(32).bool(message.hideCrosshair);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBTouchScreenControls();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.touchInputs.push(PBTouchScreenControls_TouchInput.decode(reader, reader.uint32()));
+          continue;
+        case 2:
+          if (tag !== 16) {
+            break;
+          }
+
+          message.mainAction = reader.int32() as any;
+          continue;
+        case 3:
+          if (tag !== 24) {
+            break;
+          }
+
+          message.hideJoystick = reader.bool();
+          continue;
+        case 4:
+          if (tag !== 32) {
+            break;
+          }
+
+          message.hideCrosshair = reader.bool();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBTouchScreenControls {
+    return {
+      touchInputs: Array.isArray(object?.touchInputs)
+        ? object.touchInputs.map((e: any) => PBTouchScreenControls_TouchInput.fromJSON(e))
+        : [],
+      mainAction: isSet(object.mainAction) ? inputActionFromJSON(object.mainAction) : undefined,
+      hideJoystick: isSet(object.hideJoystick) ? Boolean(object.hideJoystick) : false,
+      hideCrosshair: isSet(object.hideCrosshair) ? Boolean(object.hideCrosshair) : false,
+    };
+  }
+
+  export function toJSON(message: PBTouchScreenControls): unknown {
+    const obj: any = {};
+    if (message.touchInputs) {
+      obj.touchInputs = message.touchInputs.map((e) => e ? PBTouchScreenControls_TouchInput.toJSON(e) : undefined);
+    } else {
+      obj.touchInputs = [];
+    }
+    message.mainAction !== undefined &&
+      (obj.mainAction = message.mainAction !== undefined ? inputActionToJSON(message.mainAction) : undefined);
+    message.hideJoystick !== undefined && (obj.hideJoystick = message.hideJoystick);
+    message.hideCrosshair !== undefined && (obj.hideCrosshair = message.hideCrosshair);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBTouchScreenControls>, I>>(base?: I): PBTouchScreenControls {
+    return PBTouchScreenControls.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBTouchScreenControls>, I>>(
+    object: I,
+  ): PBTouchScreenControls {
+    const message = createBasePBTouchScreenControls();
+    message.touchInputs = object.touchInputs?.map((e) => PBTouchScreenControls_TouchInput.fromPartial(e)) || [];
+    message.mainAction = object.mainAction ?? undefined;
+    message.hideJoystick = object.hideJoystick ?? false;
+    message.hideCrosshair = object.hideCrosshair ?? false;
+    return message;
+  }
+}
+
+function createBasePBTouchScreenControls_TouchInput(): PBTouchScreenControls_TouchInput {
+  return { inputAction: 0, hide: false, icon: undefined };
+}
+
+export namespace PBTouchScreenControls_TouchInput {
+  export function encode(
+    message: PBTouchScreenControls_TouchInput,
+    writer: _m0.Writer = _m0.Writer.create(),
+  ): _m0.Writer {
+    if (message.inputAction !== 0) {
+      writer.uint32(8).int32(message.inputAction);
+    }
+    if (message.hide === true) {
+      writer.uint32(16).bool(message.hide);
+    }
+    if (message.icon !== undefined) {
+      TextureUnion.encode(message.icon, writer.uint32(26).fork()).ldelim();
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls_TouchInput {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBTouchScreenControls_TouchInput();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 8) {
+            break;
+          }
+
+          message.inputAction = reader.int32() as any;
+          continue;
+        case 2:
+          if (tag !== 16) {
+            break;
+          }
+
+          message.hide = reader.bool();
+          continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.icon = TextureUnion.decode(reader, reader.uint32());
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBTouchScreenControls_TouchInput {
+    return {
+      inputAction: isSet(object.inputAction) ? inputActionFromJSON(object.inputAction) : 0,
+      hide: isSet(object.hide) ? Boolean(object.hide) : false,
+      icon: isSet(object.icon) ? TextureUnion.fromJSON(object.icon) : undefined,
+    };
+  }
+
+  export function toJSON(message: PBTouchScreenControls_TouchInput): unknown {
+    const obj: any = {};
+    message.inputAction !== undefined && (obj.inputAction = inputActionToJSON(message.inputAction));
+    message.hide !== undefined && (obj.hide = message.hide);
+    message.icon !== undefined && (obj.icon = message.icon ? TextureUnion.toJSON(message.icon) : undefined);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBTouchScreenControls_TouchInput>, I>>(
+    base?: I,
+  ): PBTouchScreenControls_TouchInput {
+    return PBTouchScreenControls_TouchInput.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBTouchScreenControls_TouchInput>, I>>(
+    object: I,
+  ): PBTouchScreenControls_TouchInput {
+    const message = createBasePBTouchScreenControls_TouchInput();
+    message.inputAction = object.inputAction ?? 0;
+    message.hide = object.hide ?? false;
+    message.icon = (object.icon !== undefined && object.icon !== null)
+      ? TextureUnion.fromPartial(object.icon)
+      : undefined;
+    return message;
+  }
+}
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends { $case: string } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { $case: T["$case"] }
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}