@dcl/protocol 1.0.0-3761391741.commit-d4dfa66 → 1.0.0-3808528053.commit-d66d462

package/out-ts/decentraland/kernel/apis/restricted_actions.gen.ts

@@ -17,6 +17,11 @@ export interface MovePlayerToRequest {
   cameraTarget?: Vector3 | undefined;
 }
 
+export interface TeleportToRequest {
+  worldPosition: Vector3 | undefined;
+  cameraTarget?: Vector3 | undefined;
+}
+
 export interface TriggerEmoteResponse {
 }
 
@@ -24,6 +29,30 @@ export interface TriggerEmoteRequest {
   predefinedEmote: string;
 }
 
+export interface ChangeRealmRequest {
+  realm: string;
+  message?: string | undefined;
+}
+
+export interface OpenExternalUrlRequest {
+  url: string;
+}
+
+export interface OpenNftDialogRequest {
+  urn: string;
+}
+
+export interface UnblockPointerRequest {
+}
+
+export interface CommsAdapterRequest {
+  connectionString: string;
+}
+
+export interface SuccessResponse {
+  success: boolean;
+}
+
 function createBaseVector3(): Vector3 {
   return { x: 0, y: 0, z: 0 };
 }
@@ -194,6 +223,70 @@ export const MovePlayerToRequest = {
   },
 };
 
+function createBaseTeleportToRequest(): TeleportToRequest {
+  return { worldPosition: undefined, cameraTarget: undefined };
+}
+
+export const TeleportToRequest = {
+  encode(message: TeleportToRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.worldPosition !== undefined) {
+      Vector3.encode(message.worldPosition, writer.uint32(10).fork()).ldelim();
+    }
+    if (message.cameraTarget !== undefined) {
+      Vector3.encode(message.cameraTarget, writer.uint32(18).fork()).ldelim();
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): TeleportToRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseTeleportToRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.worldPosition = Vector3.decode(reader, reader.uint32());
+          break;
+        case 2:
+          message.cameraTarget = Vector3.decode(reader, reader.uint32());
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): TeleportToRequest {
+    return {
+      worldPosition: isSet(object.worldPosition) ? Vector3.fromJSON(object.worldPosition) : undefined,
+      cameraTarget: isSet(object.cameraTarget) ? Vector3.fromJSON(object.cameraTarget) : undefined,
+    };
+  },
+
+  toJSON(message: TeleportToRequest): unknown {
+    const obj: any = {};
+    message.worldPosition !== undefined &&
+      (obj.worldPosition = message.worldPosition ? Vector3.toJSON(message.worldPosition) : undefined);
+    message.cameraTarget !== undefined &&
+      (obj.cameraTarget = message.cameraTarget ? Vector3.toJSON(message.cameraTarget) : undefined);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<TeleportToRequest>, I>>(object: I): TeleportToRequest {
+    const message = createBaseTeleportToRequest();
+    message.worldPosition = (object.worldPosition !== undefined && object.worldPosition !== null)
+      ? Vector3.fromPartial(object.worldPosition)
+      : undefined;
+    message.cameraTarget = (object.cameraTarget !== undefined && object.cameraTarget !== null)
+      ? Vector3.fromPartial(object.cameraTarget)
+      : undefined;
+    return message;
+  },
+};
+
 function createBaseTriggerEmoteResponse(): TriggerEmoteResponse {
   return {};
 }
@@ -280,11 +373,297 @@ export const TriggerEmoteRequest = {
   },
 };
 
+function createBaseChangeRealmRequest(): ChangeRealmRequest {
+  return { realm: "", message: undefined };
+}
+
+export const ChangeRealmRequest = {
+  encode(message: ChangeRealmRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.realm !== "") {
+      writer.uint32(10).string(message.realm);
+    }
+    if (message.message !== undefined) {
+      writer.uint32(18).string(message.message);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): ChangeRealmRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseChangeRealmRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.realm = reader.string();
+          break;
+        case 2:
+          message.message = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): ChangeRealmRequest {
+    return {
+      realm: isSet(object.realm) ? String(object.realm) : "",
+      message: isSet(object.message) ? String(object.message) : undefined,
+    };
+  },
+
+  toJSON(message: ChangeRealmRequest): unknown {
+    const obj: any = {};
+    message.realm !== undefined && (obj.realm = message.realm);
+    message.message !== undefined && (obj.message = message.message);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<ChangeRealmRequest>, I>>(object: I): ChangeRealmRequest {
+    const message = createBaseChangeRealmRequest();
+    message.realm = object.realm ?? "";
+    message.message = object.message ?? undefined;
+    return message;
+  },
+};
+
+function createBaseOpenExternalUrlRequest(): OpenExternalUrlRequest {
+  return { url: "" };
+}
+
+export const OpenExternalUrlRequest = {
+  encode(message: OpenExternalUrlRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.url !== "") {
+      writer.uint32(10).string(message.url);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): OpenExternalUrlRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseOpenExternalUrlRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.url = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): OpenExternalUrlRequest {
+    return { url: isSet(object.url) ? String(object.url) : "" };
+  },
+
+  toJSON(message: OpenExternalUrlRequest): unknown {
+    const obj: any = {};
+    message.url !== undefined && (obj.url = message.url);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<OpenExternalUrlRequest>, I>>(object: I): OpenExternalUrlRequest {
+    const message = createBaseOpenExternalUrlRequest();
+    message.url = object.url ?? "";
+    return message;
+  },
+};
+
+function createBaseOpenNftDialogRequest(): OpenNftDialogRequest {
+  return { urn: "" };
+}
+
+export const OpenNftDialogRequest = {
+  encode(message: OpenNftDialogRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.urn !== "") {
+      writer.uint32(10).string(message.urn);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): OpenNftDialogRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseOpenNftDialogRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.urn = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): OpenNftDialogRequest {
+    return { urn: isSet(object.urn) ? String(object.urn) : "" };
+  },
+
+  toJSON(message: OpenNftDialogRequest): unknown {
+    const obj: any = {};
+    message.urn !== undefined && (obj.urn = message.urn);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<OpenNftDialogRequest>, I>>(object: I): OpenNftDialogRequest {
+    const message = createBaseOpenNftDialogRequest();
+    message.urn = object.urn ?? "";
+    return message;
+  },
+};
+
+function createBaseUnblockPointerRequest(): UnblockPointerRequest {
+  return {};
+}
+
+export const UnblockPointerRequest = {
+  encode(_: UnblockPointerRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): UnblockPointerRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseUnblockPointerRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(_: any): UnblockPointerRequest {
+    return {};
+  },
+
+  toJSON(_: UnblockPointerRequest): unknown {
+    const obj: any = {};
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<UnblockPointerRequest>, I>>(_: I): UnblockPointerRequest {
+    const message = createBaseUnblockPointerRequest();
+    return message;
+  },
+};
+
+function createBaseCommsAdapterRequest(): CommsAdapterRequest {
+  return { connectionString: "" };
+}
+
+export const CommsAdapterRequest = {
+  encode(message: CommsAdapterRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.connectionString !== "") {
+      writer.uint32(10).string(message.connectionString);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): CommsAdapterRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseCommsAdapterRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.connectionString = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): CommsAdapterRequest {
+    return { connectionString: isSet(object.connectionString) ? String(object.connectionString) : "" };
+  },
+
+  toJSON(message: CommsAdapterRequest): unknown {
+    const obj: any = {};
+    message.connectionString !== undefined && (obj.connectionString = message.connectionString);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<CommsAdapterRequest>, I>>(object: I): CommsAdapterRequest {
+    const message = createBaseCommsAdapterRequest();
+    message.connectionString = object.connectionString ?? "";
+    return message;
+  },
+};
+
+function createBaseSuccessResponse(): SuccessResponse {
+  return { success: false };
+}
+
+export const SuccessResponse = {
+  encode(message: SuccessResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.success === true) {
+      writer.uint32(8).bool(message.success);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): SuccessResponse {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseSuccessResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.success = reader.bool();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): SuccessResponse {
+    return { success: isSet(object.success) ? Boolean(object.success) : false };
+  },
+
+  toJSON(message: SuccessResponse): unknown {
+    const obj: any = {};
+    message.success !== undefined && (obj.success = message.success);
+    return obj;
+  },
+
+  fromPartial<I extends Exact<DeepPartial<SuccessResponse>, I>>(object: I): SuccessResponse {
+    const message = createBaseSuccessResponse();
+    message.success = object.success ?? false;
+    return message;
+  },
+};
+
 export type RestrictedActionsServiceDefinition = typeof RestrictedActionsServiceDefinition;
 export const RestrictedActionsServiceDefinition = {
   name: "RestrictedActionsService",
   fullName: "decentraland.kernel.apis.RestrictedActionsService",
   methods: {
+    /** MovePlayerTo will move the player in a position relative to the current scene */
     movePlayerTo: {
       name: "MovePlayerTo",
       requestType: MovePlayerToRequest,
@@ -293,6 +672,16 @@ export const RestrictedActionsServiceDefinition = {
       responseStream: false,
       options: {},
     },
+    /** TeleportTo will move the user into an absolute world position */
+    teleportTo: {
+      name: "TeleportTo",
+      requestType: TeleportToRequest,
+      requestStream: false,
+      responseType: MovePlayerToResponse,
+      responseStream: false,
+      options: {},
+    },
+    /** TriggerEmote will trigger an emote in this current user */
     triggerEmote: {
       name: "TriggerEmote",
       requestType: TriggerEmoteRequest,
@@ -301,6 +690,45 @@ export const RestrictedActionsServiceDefinition = {
       responseStream: false,
       options: {},
     },
+    /** ChangeRealm prompts the user to change to a specific realm */
+    changeRealm: {
+      name: "ChangeRealm",
+      requestType: ChangeRealmRequest,
+      requestStream: false,
+      responseType: SuccessResponse,
+      responseStream: false,
+      options: {},
+    },
+    /** OpenExternalUrl prompts the user to open an external link */
+    openExternalUrl: {
+      name: "OpenExternalUrl",
+      requestType: OpenExternalUrlRequest,
+      requestStream: false,
+      responseType: SuccessResponse,
+      responseStream: false,
+      options: {},
+    },
+    /** OpenNftDialog opens an NFT dialog. */
+    openNftDialog: {
+      name: "OpenNftDialog",
+      requestType: OpenNftDialogRequest,
+      requestStream: false,
+      responseType: SuccessResponse,
+      responseStream: false,
+      options: {},
+    },
+    /**
+     * Asks the explorer to connect to other communications adapter, this feature
+     * can be used to join private game servers
+     */
+    setCommunicationsAdapter: {
+      name: "SetCommunicationsAdapter",
+      requestType: CommsAdapterRequest,
+      requestStream: false,
+      responseType: SuccessResponse,
+      responseStream: false,
+      options: {},
+    },
   },
 } as const;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/protocol",
-  "version": "1.0.0-3761391741.commit-d4dfa66",
+  "version": "1.0.0-3808528053.commit-d66d462",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -25,5 +25,5 @@
     "out-ts",
     "public"
   ],
-  "commit": "d4dfa66fc86c7c10b8e7c302ae1723c6734691b1"
+  "commit": "d66d46238f6713d295d8bd2a9c090ba13345034b"
 }

package/proto/decentraland/common/border_rect.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+package decentraland.common;
+
+// Defines indents from respective edges
+message BorderRect {
+  float top = 1;
+  float left = 2;
+  float right = 3;
+  float bottom = 4; 
+}

package/proto/decentraland/kernel/apis/restricted_actions.proto

@@ -10,17 +10,64 @@ message Vector3 {
 message MovePlayerToResponse { }
 
 message MovePlayerToRequest {
-    Vector3 new_relative_position = 1;
-    optional Vector3 camera_target = 2;
+  Vector3 new_relative_position = 1;
+  optional Vector3 camera_target = 2;
+}
+
+message TeleportToRequest {
+  Vector3 world_position = 1;
+  optional Vector3 camera_target = 2;
 }
 
 message TriggerEmoteResponse { }
 
 message TriggerEmoteRequest {
-    string predefined_emote = 1;
+  string predefined_emote = 1;
+}
+
+message ChangeRealmRequest {
+  string realm = 1;
+  optional string message = 2;
+}
+
+message OpenExternalUrlRequest {
+  string url = 1;
+}
+
+message OpenNftDialogRequest {
+  string urn = 1;
+}
+
+message UnblockPointerRequest {}
+
+message CommsAdapterRequest {
+  string connection_string = 1;
+}
+
+message SuccessResponse {
+  bool success = 1;
 }
 
 service RestrictedActionsService {
-    rpc MovePlayerTo(MovePlayerToRequest) returns (MovePlayerToResponse) {}
-    rpc TriggerEmote(TriggerEmoteRequest) returns (TriggerEmoteResponse) {}
+  // MovePlayerTo will move the player in a position relative to the current scene
+  rpc MovePlayerTo(MovePlayerToRequest) returns (MovePlayerToResponse) {}
+
+  // TeleportTo will move the user into an absolute world position
+  rpc TeleportTo(TeleportToRequest) returns (MovePlayerToResponse) {}
+
+  // TriggerEmote will trigger an emote in this current user
+  rpc TriggerEmote(TriggerEmoteRequest) returns (TriggerEmoteResponse) {}
+
+  // ChangeRealm prompts the user to change to a specific realm
+  rpc ChangeRealm(ChangeRealmRequest) returns (SuccessResponse) {}
+
+  // OpenExternalUrl prompts the user to open an external link
+  rpc OpenExternalUrl(OpenExternalUrlRequest) returns (SuccessResponse) {}
+
+  // OpenNftDialog opens an NFT dialog.
+  rpc OpenNftDialog(OpenNftDialogRequest) returns (SuccessResponse) {}
+
+  // Asks the explorer to connect to other communications adapter, this feature
+  // can be used to join private game servers
+  rpc SetCommunicationsAdapter(CommsAdapterRequest) returns (SuccessResponse) {}
 }

package/proto/decentraland/sdk/components/{pointer_hover_feedback.proto → pointer_events.proto}

@@ -14,7 +14,7 @@ enum PointerEventType {
   PET_HOVER_LEAVE = 3;
 }
 
-message PBPointerHoverFeedback {
+message PBPointerEvents {
   message Info {
     optional common.InputAction button = 1; // default=InputAction.ANY
     optional string hover_text = 2; // default='Interact'

package/proto/decentraland/sdk/components/pointer_events_result.proto

@@ -4,7 +4,7 @@ package decentraland.sdk.components;
 
 import "decentraland/sdk/components/common/id.proto";
 import "decentraland/sdk/components/common/input_action.proto";
-import "decentraland/sdk/components/pointer_hover_feedback.proto";
+import "decentraland/sdk/components/pointer_events.proto";
 import "decentraland/sdk/components/raycast_result.proto";
 
 option (common.ecs_component_id) = 1063;

package/proto/decentraland/sdk/components/text_shape.proto

@@ -20,8 +20,11 @@ message PBTextShape {
   optional float padding_right = 9;
   optional float padding_bottom = 10;
   optional float padding_left = 11;
+  // The amount of additional spacing to add between each lines of text.
   optional float line_spacing = 12;
+  // Allows control over how many lines of text are displayed.
   optional int32 line_count = 13;
+  // Enables text wrapping
   optional bool text_wrapping = 14;
   optional float shadow_blur = 15;
   optional float shadow_offset_x = 16;

package/proto/decentraland/sdk/components/ui_background.proto

@@ -5,7 +5,30 @@ import "decentraland/sdk/components/common/id.proto";
 option (common.ecs_component_id) = 1053;
 
 import "decentraland/common/colors.proto";
+import "decentraland/common/texture.proto";
+import "decentraland/common/border_rect.proto";
 
 message PBUiBackground {
-  optional decentraland.common.Color4 background_color = 1; // default=(0.0, 0.0, 0.0, 0.0)
-}
+  optional decentraland.common.Color4 color = 1; // default=(1.0, 1.0, 1.0, 1.0), pixel = color * sample2D(texture, uv)
+  optional decentraland.common.TextureUnion texture = 2;
+  BackgroundTextureMode texture_mode = 3;
+  optional decentraland.common.BorderRect texture_slices = 4; // default=(1/3, 1/3, 1/3, 1/3)
+  repeated float uvs = 5; // default=[0,0,0,1,1,0,1,0]: starting from bottom-left vertex clock-wise
+}
+
+enum BackgroundTextureMode {
+  // https://docs.unity3d.com/Manual/UIE-USS-SupportedProperties.html (Slicing section)
+  // https://forum.unity.com/threads/how-does-slicing-in-ui-tookkit-works.1235863/
+  // https://docs.unity3d.com/Manual/9SliceSprites.html
+  // https://developer.mozilla.org/en-US/docs/Web/CSS/border-image-slice
+  NINE_SLICES = 0;
+  
+  // CENTER enables the texture to be rendered centered in relation to the
+  // element. If the element is smaller than the texture then the background
+  // should use the element as stencil to cut off the out-of-bounds area
+  CENTER = 1;
+  
+  // STRETCH enables the texture to cover all the area of the container,
+  // adopting its aspect ratio.
+  STRETCH = 2;
+}

package/proto/decentraland/sdk/components/ui_dropdown.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/common/texts.proto";
+
+option (common.ecs_component_id) = 1094;
+
+message PBUiDropdown {
+  bool accept_empty = 1;
+  optional string empty_label = 2;
+  repeated string options = 3;
+  optional int32 selected_index = 4; // default=null when accept_empty==true; default=0 when accept_empty==false
+  bool disabled = 5;
+  optional decentraland.common.Color4 color = 6; // default=(0.0,0.0,0.0,1.0)
+  
+  optional common.TextAlignMode text_align = 10; // default='center'
+  optional common.Font font = 11; // default=0
+  optional int32 font_size = 12; // default=10
+}

package/proto/decentraland/sdk/components/ui_dropdown_result.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1096;
+
+message PBUiDropdownResult {
+  int32 value = 1;
+}

package/proto/decentraland/sdk/components/ui_input.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/common/texts.proto";
+
+option (common.ecs_component_id) = 1093;
+
+message PBUiInput {
+  string placeholder = 1;
+  optional decentraland.common.Color4 color = 2; // default=(0.0,0.0,0.0,1.0)
+  optional decentraland.common.Color4 placeholder_color = 3; // default=(0.3,0.3,0.3,1.0)
+  bool disabled = 4;
+  optional common.TextAlignMode text_align = 10; // default='center'
+  optional common.Font font = 11; // default=0
+  optional int32 font_size = 12; // default=10
+}

package/proto/decentraland/sdk/components/ui_input_result.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1095;
+
+message PBUiInputResult {
+  string value = 1;
+}