@dcl/protocol 1.0.0-3587979266.commit-9fcad98 → 1.0.0-35899496093.commit-329ba0e

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

@@ -0,0 +1,432 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+import { Vector3 } from "../../common/vectors.gen";
+import { PBAvatarLocomotionSettings } from "./avatar_locomotion_settings.gen";
+import { PBInputModifier } from "./input_modifier.gen";
+
+export const protobufPackage = "decentraland.sdk.components";
+
+export interface PBAvatarMovementInfo {
+  /** the length of time the current step velocity will apply for */
+  stepTime: number;
+  /** the length of time the previous step velocity applied for */
+  previousStepTime: number;
+  /** the velocity requested for the previous frame */
+  requestedVelocity:
+    | Vector3
+    | undefined;
+  /** the resulting velocity taking collisions into account */
+  actualVelocity:
+    | Vector3
+    | undefined;
+  /** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
+  externalVelocity: Vector3 | undefined;
+  activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
+  activeInputModifier:
+    | PBInputModifier
+    | undefined;
+  /** if set, the movement scene should walk the player to this scene-relative position */
+  walkTarget?:
+    | Vector3
+    | undefined;
+  /** stop distance for walk_target; considered reached when within this distance */
+  walkThreshold?:
+    | number
+    | undefined;
+  /** current state of a scene-driven movement animation. Absent when the engine is using its velocity-based fallback. `playback_time` freezes while a triggerSceneEmote is overriding the animation. */
+  activeAnimationState?: AvatarAnimationState | undefined;
+}
+
+/**
+ * Mirror of the scene-driven movement animation currently playing, reported by the engine.
+ * Readable by any scene (not just the controller) so niche effects (e.g. dust cloud on landing) can react.
+ * Active emotes are not represented here — scenes already have their own way to read them.
+ */
+export interface AvatarAnimationState {
+  /** same scene-relative path the controlling scene supplied */
+  src: string;
+  /** mirrors the request */
+  loop: boolean;
+  /** mirrors the request */
+  speed: number;
+  /** mirrors the request */
+  idle: boolean;
+  /** seconds into the clip; wraps on loop; frozen while an emote override is playing */
+  playbackTime: number;
+  /** total clip length in seconds */
+  duration: number;
+  /** how many times the clip has completed since it started */
+  loopCount: number;
+}
+
+function createBasePBAvatarMovementInfo(): PBAvatarMovementInfo {
+  return {
+    stepTime: 0,
+    previousStepTime: 0,
+    requestedVelocity: undefined,
+    actualVelocity: undefined,
+    externalVelocity: undefined,
+    activeAvatarLocomotionSettings: undefined,
+    activeInputModifier: undefined,
+    walkTarget: undefined,
+    walkThreshold: undefined,
+    activeAnimationState: undefined,
+  };
+}
+
+export namespace PBAvatarMovementInfo {
+  export function encode(message: PBAvatarMovementInfo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.stepTime !== 0) {
+      writer.uint32(13).float(message.stepTime);
+    }
+    if (message.previousStepTime !== 0) {
+      writer.uint32(21).float(message.previousStepTime);
+    }
+    if (message.requestedVelocity !== undefined) {
+      Vector3.encode(message.requestedVelocity, writer.uint32(26).fork()).ldelim();
+    }
+    if (message.actualVelocity !== undefined) {
+      Vector3.encode(message.actualVelocity, writer.uint32(34).fork()).ldelim();
+    }
+    if (message.externalVelocity !== undefined) {
+      Vector3.encode(message.externalVelocity, writer.uint32(42).fork()).ldelim();
+    }
+    if (message.activeAvatarLocomotionSettings !== undefined) {
+      PBAvatarLocomotionSettings.encode(message.activeAvatarLocomotionSettings, writer.uint32(50).fork()).ldelim();
+    }
+    if (message.activeInputModifier !== undefined) {
+      PBInputModifier.encode(message.activeInputModifier, writer.uint32(58).fork()).ldelim();
+    }
+    if (message.walkTarget !== undefined) {
+      Vector3.encode(message.walkTarget, writer.uint32(66).fork()).ldelim();
+    }
+    if (message.walkThreshold !== undefined) {
+      writer.uint32(77).float(message.walkThreshold);
+    }
+    if (message.activeAnimationState !== undefined) {
+      AvatarAnimationState.encode(message.activeAnimationState, writer.uint32(82).fork()).ldelim();
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBAvatarMovementInfo();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 13) {
+            break;
+          }
+
+          message.stepTime = reader.float();
+          continue;
+        case 2:
+          if (tag !== 21) {
+            break;
+          }
+
+          message.previousStepTime = reader.float();
+          continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.requestedVelocity = Vector3.decode(reader, reader.uint32());
+          continue;
+        case 4:
+          if (tag !== 34) {
+            break;
+          }
+
+          message.actualVelocity = Vector3.decode(reader, reader.uint32());
+          continue;
+        case 5:
+          if (tag !== 42) {
+            break;
+          }
+
+          message.externalVelocity = Vector3.decode(reader, reader.uint32());
+          continue;
+        case 6:
+          if (tag !== 50) {
+            break;
+          }
+
+          message.activeAvatarLocomotionSettings = PBAvatarLocomotionSettings.decode(reader, reader.uint32());
+          continue;
+        case 7:
+          if (tag !== 58) {
+            break;
+          }
+
+          message.activeInputModifier = PBInputModifier.decode(reader, reader.uint32());
+          continue;
+        case 8:
+          if (tag !== 66) {
+            break;
+          }
+
+          message.walkTarget = Vector3.decode(reader, reader.uint32());
+          continue;
+        case 9:
+          if (tag !== 77) {
+            break;
+          }
+
+          message.walkThreshold = reader.float();
+          continue;
+        case 10:
+          if (tag !== 82) {
+            break;
+          }
+
+          message.activeAnimationState = AvatarAnimationState.decode(reader, reader.uint32());
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBAvatarMovementInfo {
+    return {
+      stepTime: isSet(object.stepTime) ? Number(object.stepTime) : 0,
+      previousStepTime: isSet(object.previousStepTime) ? Number(object.previousStepTime) : 0,
+      requestedVelocity: isSet(object.requestedVelocity) ? Vector3.fromJSON(object.requestedVelocity) : undefined,
+      actualVelocity: isSet(object.actualVelocity) ? Vector3.fromJSON(object.actualVelocity) : undefined,
+      externalVelocity: isSet(object.externalVelocity) ? Vector3.fromJSON(object.externalVelocity) : undefined,
+      activeAvatarLocomotionSettings: isSet(object.activeAvatarLocomotionSettings)
+        ? PBAvatarLocomotionSettings.fromJSON(object.activeAvatarLocomotionSettings)
+        : undefined,
+      activeInputModifier: isSet(object.activeInputModifier)
+        ? PBInputModifier.fromJSON(object.activeInputModifier)
+        : undefined,
+      walkTarget: isSet(object.walkTarget) ? Vector3.fromJSON(object.walkTarget) : undefined,
+      walkThreshold: isSet(object.walkThreshold) ? Number(object.walkThreshold) : undefined,
+      activeAnimationState: isSet(object.activeAnimationState)
+        ? AvatarAnimationState.fromJSON(object.activeAnimationState)
+        : undefined,
+    };
+  }
+
+  export function toJSON(message: PBAvatarMovementInfo): unknown {
+    const obj: any = {};
+    message.stepTime !== undefined && (obj.stepTime = message.stepTime);
+    message.previousStepTime !== undefined && (obj.previousStepTime = message.previousStepTime);
+    message.requestedVelocity !== undefined &&
+      (obj.requestedVelocity = message.requestedVelocity ? Vector3.toJSON(message.requestedVelocity) : undefined);
+    message.actualVelocity !== undefined &&
+      (obj.actualVelocity = message.actualVelocity ? Vector3.toJSON(message.actualVelocity) : undefined);
+    message.externalVelocity !== undefined &&
+      (obj.externalVelocity = message.externalVelocity ? Vector3.toJSON(message.externalVelocity) : undefined);
+    message.activeAvatarLocomotionSettings !== undefined &&
+      (obj.activeAvatarLocomotionSettings = message.activeAvatarLocomotionSettings
+        ? PBAvatarLocomotionSettings.toJSON(message.activeAvatarLocomotionSettings)
+        : undefined);
+    message.activeInputModifier !== undefined &&
+      (obj.activeInputModifier = message.activeInputModifier
+        ? PBInputModifier.toJSON(message.activeInputModifier)
+        : undefined);
+    message.walkTarget !== undefined &&
+      (obj.walkTarget = message.walkTarget ? Vector3.toJSON(message.walkTarget) : undefined);
+    message.walkThreshold !== undefined && (obj.walkThreshold = message.walkThreshold);
+    message.activeAnimationState !== undefined &&
+      (obj.activeAnimationState = message.activeAnimationState
+        ? AvatarAnimationState.toJSON(message.activeAnimationState)
+        : undefined);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBAvatarMovementInfo>, I>>(base?: I): PBAvatarMovementInfo {
+    return PBAvatarMovementInfo.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBAvatarMovementInfo>, I>>(object: I): PBAvatarMovementInfo {
+    const message = createBasePBAvatarMovementInfo();
+    message.stepTime = object.stepTime ?? 0;
+    message.previousStepTime = object.previousStepTime ?? 0;
+    message.requestedVelocity = (object.requestedVelocity !== undefined && object.requestedVelocity !== null)
+      ? Vector3.fromPartial(object.requestedVelocity)
+      : undefined;
+    message.actualVelocity = (object.actualVelocity !== undefined && object.actualVelocity !== null)
+      ? Vector3.fromPartial(object.actualVelocity)
+      : undefined;
+    message.externalVelocity = (object.externalVelocity !== undefined && object.externalVelocity !== null)
+      ? Vector3.fromPartial(object.externalVelocity)
+      : undefined;
+    message.activeAvatarLocomotionSettings =
+      (object.activeAvatarLocomotionSettings !== undefined && object.activeAvatarLocomotionSettings !== null)
+        ? PBAvatarLocomotionSettings.fromPartial(object.activeAvatarLocomotionSettings)
+        : undefined;
+    message.activeInputModifier = (object.activeInputModifier !== undefined && object.activeInputModifier !== null)
+      ? PBInputModifier.fromPartial(object.activeInputModifier)
+      : undefined;
+    message.walkTarget = (object.walkTarget !== undefined && object.walkTarget !== null)
+      ? Vector3.fromPartial(object.walkTarget)
+      : undefined;
+    message.walkThreshold = object.walkThreshold ?? undefined;
+    message.activeAnimationState = (object.activeAnimationState !== undefined && object.activeAnimationState !== null)
+      ? AvatarAnimationState.fromPartial(object.activeAnimationState)
+      : undefined;
+    return message;
+  }
+}
+
+function createBaseAvatarAnimationState(): AvatarAnimationState {
+  return { src: "", loop: false, speed: 0, idle: false, playbackTime: 0, duration: 0, loopCount: 0 };
+}
+
+export namespace AvatarAnimationState {
+  export function encode(message: AvatarAnimationState, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.src !== "") {
+      writer.uint32(10).string(message.src);
+    }
+    if (message.loop === true) {
+      writer.uint32(16).bool(message.loop);
+    }
+    if (message.speed !== 0) {
+      writer.uint32(29).float(message.speed);
+    }
+    if (message.idle === true) {
+      writer.uint32(32).bool(message.idle);
+    }
+    if (message.playbackTime !== 0) {
+      writer.uint32(45).float(message.playbackTime);
+    }
+    if (message.duration !== 0) {
+      writer.uint32(53).float(message.duration);
+    }
+    if (message.loopCount !== 0) {
+      writer.uint32(56).uint32(message.loopCount);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarAnimationState {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseAvatarAnimationState();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.src = reader.string();
+          continue;
+        case 2:
+          if (tag !== 16) {
+            break;
+          }
+
+          message.loop = reader.bool();
+          continue;
+        case 3:
+          if (tag !== 29) {
+            break;
+          }
+
+          message.speed = reader.float();
+          continue;
+        case 4:
+          if (tag !== 32) {
+            break;
+          }
+
+          message.idle = reader.bool();
+          continue;
+        case 5:
+          if (tag !== 45) {
+            break;
+          }
+
+          message.playbackTime = reader.float();
+          continue;
+        case 6:
+          if (tag !== 53) {
+            break;
+          }
+
+          message.duration = reader.float();
+          continue;
+        case 7:
+          if (tag !== 56) {
+            break;
+          }
+
+          message.loopCount = reader.uint32();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): AvatarAnimationState {
+    return {
+      src: isSet(object.src) ? String(object.src) : "",
+      loop: isSet(object.loop) ? Boolean(object.loop) : false,
+      speed: isSet(object.speed) ? Number(object.speed) : 0,
+      idle: isSet(object.idle) ? Boolean(object.idle) : false,
+      playbackTime: isSet(object.playbackTime) ? Number(object.playbackTime) : 0,
+      duration: isSet(object.duration) ? Number(object.duration) : 0,
+      loopCount: isSet(object.loopCount) ? Number(object.loopCount) : 0,
+    };
+  }
+
+  export function toJSON(message: AvatarAnimationState): unknown {
+    const obj: any = {};
+    message.src !== undefined && (obj.src = message.src);
+    message.loop !== undefined && (obj.loop = message.loop);
+    message.speed !== undefined && (obj.speed = message.speed);
+    message.idle !== undefined && (obj.idle = message.idle);
+    message.playbackTime !== undefined && (obj.playbackTime = message.playbackTime);
+    message.duration !== undefined && (obj.duration = message.duration);
+    message.loopCount !== undefined && (obj.loopCount = Math.round(message.loopCount));
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<AvatarAnimationState>, I>>(base?: I): AvatarAnimationState {
+    return AvatarAnimationState.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<AvatarAnimationState>, I>>(object: I): AvatarAnimationState {
+    const message = createBaseAvatarAnimationState();
+    message.src = object.src ?? "";
+    message.loop = object.loop ?? false;
+    message.speed = object.speed ?? 0;
+    message.idle = object.idle ?? false;
+    message.playbackTime = object.playbackTime ?? 0;
+    message.duration = object.duration ?? 0;
+    message.loopCount = object.loopCount ?? 0;
+    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;
+}

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

@@ -0,0 +1,162 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+import { Color3 } from "../../common/colors.gen";
+
+export const protobufPackage = "decentraland.sdk.components";
+
+/**
+ * The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
+ * for example to show a rank or a role that the scene assigns to that player.
+ *
+ * Valid only on an avatar-bearing entity:
+ * - the local player: `engine.PlayerEntity`
+ * - another player in the scene: that player's entity
+ * - an NPC: any entity with an AvatarShape
+ * Writes to any other entity are ignored.
+ *
+ * Player entity ids are not stable across disconnects: a write to a stale entity lands on
+ * whoever holds that id next. Resolve the entity from the user id on every write, and remove
+ * the component when the player leaves the scene.
+ *
+ * The plate is local to the client that renders it; it is never relayed to other players.
+ */
+export interface PBAvatarNametag {
+  /**
+   * The plate text: a single line, for example "Club Owner". Empty draws the plate without text,
+   * and spaces are preserved: a label of spaces widens a text-less plate. For a plate sized
+   * exactly to a word without showing it, set label_color equal to background_color instead.
+   */
+  label: string;
+  /** (default: the client's native nametag text color) */
+  labelColor?:
+    | Color3
+    | undefined;
+  /** (default: the client's native nametag background color) */
+  backgroundColor?:
+    | Color3
+    | undefined;
+  /** (default: background_color, so the plate carries no visible border) */
+  borderColor?: Color3 | undefined;
+}
+
+function createBasePBAvatarNametag(): PBAvatarNametag {
+  return { label: "", labelColor: undefined, backgroundColor: undefined, borderColor: undefined };
+}
+
+export namespace PBAvatarNametag {
+  export function encode(message: PBAvatarNametag, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.label !== "") {
+      writer.uint32(10).string(message.label);
+    }
+    if (message.labelColor !== undefined) {
+      Color3.encode(message.labelColor, writer.uint32(18).fork()).ldelim();
+    }
+    if (message.backgroundColor !== undefined) {
+      Color3.encode(message.backgroundColor, writer.uint32(26).fork()).ldelim();
+    }
+    if (message.borderColor !== undefined) {
+      Color3.encode(message.borderColor, writer.uint32(34).fork()).ldelim();
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarNametag {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBAvatarNametag();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.label = reader.string();
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.labelColor = Color3.decode(reader, reader.uint32());
+          continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.backgroundColor = Color3.decode(reader, reader.uint32());
+          continue;
+        case 4:
+          if (tag !== 34) {
+            break;
+          }
+
+          message.borderColor = Color3.decode(reader, reader.uint32());
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBAvatarNametag {
+    return {
+      label: isSet(object.label) ? String(object.label) : "",
+      labelColor: isSet(object.labelColor) ? Color3.fromJSON(object.labelColor) : undefined,
+      backgroundColor: isSet(object.backgroundColor) ? Color3.fromJSON(object.backgroundColor) : undefined,
+      borderColor: isSet(object.borderColor) ? Color3.fromJSON(object.borderColor) : undefined,
+    };
+  }
+
+  export function toJSON(message: PBAvatarNametag): unknown {
+    const obj: any = {};
+    message.label !== undefined && (obj.label = message.label);
+    message.labelColor !== undefined &&
+      (obj.labelColor = message.labelColor ? Color3.toJSON(message.labelColor) : undefined);
+    message.backgroundColor !== undefined &&
+      (obj.backgroundColor = message.backgroundColor ? Color3.toJSON(message.backgroundColor) : undefined);
+    message.borderColor !== undefined &&
+      (obj.borderColor = message.borderColor ? Color3.toJSON(message.borderColor) : undefined);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBAvatarNametag>, I>>(base?: I): PBAvatarNametag {
+    return PBAvatarNametag.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBAvatarNametag>, I>>(object: I): PBAvatarNametag {
+    const message = createBasePBAvatarNametag();
+    message.label = object.label ?? "";
+    message.labelColor = (object.labelColor !== undefined && object.labelColor !== null)
+      ? Color3.fromPartial(object.labelColor)
+      : undefined;
+    message.backgroundColor = (object.backgroundColor !== undefined && object.backgroundColor !== null)
+      ? Color3.fromPartial(object.backgroundColor)
+      : undefined;
+    message.borderColor = (object.borderColor !== undefined && object.borderColor !== null)
+      ? Color3.fromPartial(object.borderColor)
+      : 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;
+}