@dcl/protocol 1.0.0-3324030843.commit-dbdd12a → 1.0.0-33247403125.commit-6e4ee4a

package/proto/decentraland/sdk/components/ui_canvas_information.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/border_rect.proto";
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1054;
+
+// This component is created by the renderer and used by the scenes to know the resolution of the UI canvas
+message PBUiCanvasInformation {
+  // informs the scene about the resolution used for the UI rendering
+  float device_pixel_ratio = 1;
+  // informs about the width of the canvas, in virtual pixels. this value does not change when the pixel ratio changes.
+  int32 width = 2;
+  // informs about the height of the canvas, in virtual pixels. this value does not change when the pixel ratio changes.
+  int32 height = 3;
+  // informs the sdk about the interactable area. some implementations may change
+  // this area depending on the HUD that is being shown. this value may change at
+  // any time by the Renderer to create reactive UIs. as an example, an explorer with the
+  // chat UI hidden and with no minimap could have a rect that covers the whole screen.
+  // on the contrary, if the chat UI is shown, the rect would be smaller.
+  decentraland.common.BorderRect interactable_area = 4;
+  // informs the sdk about the screen inset area (safe margins). these are the
+  // insets from each edge of the screen that are reserved by the device or
+  // platform UI (for example: the notch, status bar, home indicator, or rounded
+  // corners on mobile). scenes should avoid placing critical UI within these
+  // insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).
+  optional decentraland.common.BorderRect screen_inset_area = 5;
+}

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,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) = 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
+  optional string value = 13;
+  optional bool multi_line = 14; // default=false; when true, the input accepts newlines and behaves as a textarea
+  optional bool clear_on_submit = 15; // default=true; when false, the input value is preserved after pressing Enter
+}

package/proto/decentraland/sdk/components/ui_input_binding.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/common/input_action.proto";
+option (common.ecs_component_id) = 1219;
+
+// The UiInputBinding component binds a UI entity to one or more InputActions. While the
+// element is pressed (touch or pointer) the listed actions are held down, driving both
+// the local player input and scene InputAction listeners, just like the native on-screen
+// buttons. It is typically combined with PBTouchScreenControls to replace the native
+// controls with a custom touch UI.
+//
+// Release semantics: the held actions are released as soon as the press that started them
+// ends. A renderer MUST release all actions held by this binding when any of the following
+// happens: the press/touch is lifted or cancelled, the pointer/touch leaves the element
+// (loses press ownership), the actions list changes (the previous set is released before
+// the new set is applied), the component is removed or its actions list becomes empty, the
+// UI element is hidden, disabled or removed from the tree, or the scene unloads. In short,
+// no action may remain held once the element is no longer both present and actively pressed.
+//
+// Multi-touch: the binding is a single held state, not reference-counted per pointer. The
+// actions are held while the element is pressed and released when that press ends; a second
+// simultaneous press on the same element does not stack, and does not extend the hold past
+// the first release.
+message PBUiInputBinding {
+    repeated common.InputAction actions = 1; // the input actions fired while this element is pressed
+}

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

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1095;
+
+message PBUiInputResult {
+  string value = 1;
+  optional bool is_submit = 2; // default: false
+}

package/proto/decentraland/sdk/components/ui_scroll_result.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/common/vectors.proto";
+
+option (common.ecs_component_id) = 1202;
+
+message PBUiScrollResult {
+  decentraland.common.Vector2 value = 1;
+}

package/proto/decentraland/sdk/components/ui_text.proto

@@ -8,10 +8,19 @@ import "decentraland/sdk/components/common/texts.proto";
 
 option (common.ecs_component_id) = 1052;
 
+enum TextWrap {
+  TW_WRAP = 0;
+  TW_NO_WRAP = 1;
+}
+
+// The UiText component creates a text widget inside a UI component tree. Its position and
+// layout properties can be specified in a UiTransform component on the same Entity.
+
 message PBUiText {
-  string value = 1;
-  optional decentraland.common.Color3 color = 2; // default=(1.0,1.0,1.0)
-  optional common.TextAlignMode text_align = 3; // default='center'
-  optional common.Font font = 4; // default=0
-  optional int32 font_size = 5; // default=10
+  string value = 1;                              // the text content, tag <b> and <i> are supported
+  optional decentraland.common.Color4 color = 2; // RGBA color (default: opaque white)
+  optional common.TextAlignMode text_align = 3;  // alignment within the bounds (default: center)
+  optional common.Font font = 4;                 // font for the text (default: sans-serif)
+  optional int32 font_size = 5;                  // size of the text (default: 10)
+  optional TextWrap text_wrap = 6;               // wrap text when the border is reached (default: TW_WRAP)
 }

package/proto/decentraland/sdk/components/ui_transform.proto

@@ -3,13 +3,14 @@ syntax = "proto3";
 package decentraland.sdk.components;
 
 import "decentraland/sdk/components/common/id.proto";
+import "decentraland/common/colors.proto";
+import "decentraland/common/vectors.proto";
 
 option (common.ecs_component_id) = 1050;
 
 enum YGPositionType {
-  YGPT_STATIC = 0;
-  YGPT_RELATIVE = 1;
-  YGPT_ABSOLUTE = 2;
+  YGPT_RELATIVE = 0;
+  YGPT_ABSOLUTE = 1;
 }
 
 enum YGAlign {
@@ -30,16 +31,10 @@ enum YGUnit {
   YGU_AUTO = 3;
 }
 
-enum YGDirection {
-  YGD_INHERIT = 0;
-  YGD_LTR = 1;
-  YGD_RTL = 2;
-}
-
 enum YGFlexDirection {
-  YGFD_COLUMN = 0;
-  YGFD_COLUMN_REVERSE = 1;
-  YGFD_ROW = 2;
+  YGFD_ROW = 0;
+  YGFD_COLUMN = 1;
+  YGFD_COLUMN_REVERSE = 2;
   YGFD_ROW_REVERSE = 3;
 }
 
@@ -81,83 +76,123 @@ enum YGEdge {
   YGE_ALL = 8;
 }
 
+enum PointerFilterMode {
+  PFM_NONE = 0;
+  PFM_BLOCK = 1;
+}
+
+enum ShowScrollBar {
+  SSB_BOTH = 0;
+  SSB_ONLY_VERTICAL = 1;
+  SSB_ONLY_HORIZONTAL = 2;
+  SSB_HIDDEN = 3;
+}
+
+message ScrollPositionValue {
+  oneof value {
+    decentraland.common.Vector2 position = 1;
+    string reference = 2;
+  }
+}
+
 message PBUiTransform {
-  int32 parent = 79;
-  int32 right_of = 80;
+  int32 parent = 1;
+  int32 right_of = 2;
 
-  YGPositionType position_type = 1;
+  optional YGAlign align_content = 3; // default: YGAlign.YGA_FLEX_START
+  optional YGAlign align_items = 4; // default: YGAlign.YGA_STRETCH
+  optional YGWrap flex_wrap = 5; // default: YGWrap.YGW_WRAP
+  optional float flex_shrink = 6; // default: 1
 
-  YGAlign align_content = 2;
-  YGAlign align_items = 3;
-  YGAlign align_self = 4;
-  YGFlexDirection flex_direction = 5;
-  YGWrap flex_wrap = 6;
-  YGJustify justify_content = 7;
+  YGPositionType position_type = 7; // YGPositionType.YGPT_RELATIVE
 
-  YGOverflow overflow = 8;
-  YGDisplay display = 9;
-  YGDirection direction = 10;
+  YGAlign align_self = 8; // YGAlign.YGA_AUTO
+  YGFlexDirection flex_direction = 9; // YGFlexDirection.YGFD_ROW
+  YGJustify justify_content = 10; // YGJustify.YGJ_FLEX_START
 
-  float flex = 11;
+  YGOverflow overflow = 11; // YGOverflow.YGO_VISIBLE
+  YGDisplay display = 12; // YGDisplay.YGD_FLEX
 
-  YGUnit flex_basis_unit = 13;
+  YGUnit flex_basis_unit = 13; // YGUnit.YGU_UNDEFINED
   float flex_basis = 14;
 
   float flex_grow = 15;
-  float flex_shrink = 16;
-
-  YGUnit width_unit = 17;
-  float width = 18;
-  YGUnit height_unit = 19;
-  float height = 20;
-
-  YGUnit min_width_unit = 21;
-  float min_width = 22;
-  YGUnit min_height_unit = 23;
-  float min_height = 24;
-
-  YGUnit max_width_unit = 31;
-  float max_width = 32;
-  YGUnit max_height_unit = 33;
-  float max_height = 34;
-
-  // non-standard
-  reserved 40; // float aspect_ratio = 40;
-
-  YGUnit position_left_unit = 41;
-  float position_left = 42;
-  YGUnit position_top_unit = 43;
-  float position_top = 44;
-  YGUnit position_right_unit = 45;
-  float position_right = 46;
-  YGUnit position_bottom_unit = 47;
-  float position_bottom = 48;
-
-  // margin
-  YGUnit margin_left_unit = 51;
-  float margin_left = 52;
-  YGUnit margin_top_unit = 53;
-  float margin_top = 54;
-  YGUnit margin_right_unit = 55;
-  float margin_right = 56;
-  YGUnit margin_bottom_unit = 57;
-  float margin_bottom = 58;
-
-  YGUnit padding_left_unit = 61;
-  float padding_left = 62;
-  YGUnit padding_top_unit = 63;
-  float padding_top = 64;
-  YGUnit padding_right_unit = 65;
-  float padding_right = 66;
-  YGUnit padding_bottom_unit = 67;
-  float padding_bottom = 68;
-
-  reserved 71; // YGUnit border_left_unit = 71;
-  float border_left = 72;
-  reserved 73; // YGUnit border_top_unit = 73;
-  float border_top = 74;
-  reserved 75; // YGUnit border_right_unit = 75;
-  float border_right = 76;
-  reserved 77; // YGUnit border_bottom_unit = 77;
-  float border_bottom = 78;
+
+  YGUnit width_unit = 16; // YGUnit.YGU_UNDEFINED
+  float width = 17;
+  YGUnit height_unit = 18; // YGUnit.YGU_UNDEFINED
+  float height = 19;
+
+  YGUnit min_width_unit = 20; // YGUnit.YGU_UNDEFINED
+  float min_width = 21;
+  YGUnit min_height_unit = 22; // YGUnit.YGU_UNDEFINED
+  float min_height = 23;
+
+  YGUnit max_width_unit = 24; // YGUnit.YGU_UNDEFINED
+  float max_width = 25;
+  YGUnit max_height_unit = 26; // YGUnit.YGU_UNDEFINED
+  float max_height = 27;
+
+  YGUnit position_left_unit = 28; // YGUnit.YGU_UNDEFINED
+  float position_left = 29;
+  YGUnit position_top_unit = 30; // YGUnit.YGU_UNDEFINED
+  float position_top = 31;
+  YGUnit position_right_unit = 32; // YGUnit.YGU_UNDEFINED
+  float position_right = 33;
+  YGUnit position_bottom_unit = 34; // YGUnit.YGU_UNDEFINED
+  float position_bottom = 35;
+
+  YGUnit margin_left_unit = 36; // YGUnit.YGU_UNDEFINED
+  float margin_left = 37;
+  YGUnit margin_top_unit = 38; // YGUnit.YGU_UNDEFINED
+  float margin_top = 39;
+  YGUnit margin_right_unit = 40; // YGUnit.YGU_UNDEFINED
+  float margin_right = 41;
+  YGUnit margin_bottom_unit = 42; // YGUnit.YGU_UNDEFINED
+  float margin_bottom = 43;
+
+  YGUnit padding_left_unit = 44; // YGUnit.YGU_UNDEFINED
+  float padding_left = 45;
+  YGUnit padding_top_unit = 46; // YGUnit.YGU_UNDEFINED
+  float padding_top = 47;
+  YGUnit padding_right_unit = 48; // YGUnit.YGU_UNDEFINED
+  float padding_right = 49;
+  YGUnit padding_bottom_unit = 50; // YGUnit.YGU_UNDEFINED
+  float padding_bottom = 51;
+
+  optional PointerFilterMode pointer_filter = 52; // default: PointerFilterMode.PFM_NONE
+
+  // Border Width
+  optional YGUnit border_left_width_unit = 53; // YGUnit.YGU_UNDEFINED
+  optional float border_left_width = 54;
+  optional YGUnit border_top_width_unit = 55; // YGUnit.YGU_UNDEFINED
+  optional float border_top_width = 56;
+  optional YGUnit border_right_width_unit = 57; // YGUnit.YGU_UNDEFINED
+  optional float border_right_width = 58;
+  optional YGUnit border_bottom_width_unit = 59; // YGUnit.YGU_UNDEFINED
+  optional float border_bottom_width = 60;
+
+  // Border Radius
+  optional YGUnit border_top_left_radius_unit = 61; // YGUnit.YGU_UNDEFINED
+  optional float border_top_left_radius = 62;
+  optional YGUnit border_top_right_radius_unit = 63; // YGUnit.YGU_UNDEFINED
+  optional float border_top_right_radius = 64;
+  optional YGUnit border_bottom_left_radius_unit = 65; // YGUnit.YGU_UNDEFINED
+  optional float border_bottom_left_radius = 66;
+  optional YGUnit border_bottom_right_radius_unit = 67; // YGUnit.YGU_UNDEFINED
+  optional float border_bottom_right_radius = 68;
+
+  // Border Color
+  optional decentraland.common.Color4 border_top_color = 69;
+  optional decentraland.common.Color4 border_bottom_color = 70;
+  optional decentraland.common.Color4 border_left_color = 71;
+  optional decentraland.common.Color4 border_right_color = 72;
+
+  optional float opacity = 73; // default: 1
+
+  optional string element_id = 74; // reference for scroll_position. default empty
+  optional ScrollPositionValue scroll_position = 75; // default position=(0,0)
+  optional ShowScrollBar scroll_visible = 76; // default ShowScrollBar.SSB_BOTH
+
+  optional int32 z_index = 77; // default: 0 — controls render stacking order. Higher values appear in front of lower values.
 }

package/proto/decentraland/sdk/components/video_event.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1044;
+
+message PBVideoEvent {
+  uint32 timestamp = 1;     // monotonic counter
+  uint32 tick_number = 2;   // number of tick in which the event was produced, equals to EngineInfo.tick_number
+  float current_offset = 3;
+  float video_length = 4;
+  VideoState state = 5;
+}
+
+enum VideoState {
+  VS_NONE = 0;
+  VS_ERROR = 1;
+  VS_LOADING = 2;
+  VS_READY = 3;
+  VS_PLAYING = 4;
+  VS_BUFFERING = 5;
+  VS_SEEKING = 6;
+  VS_PAUSED = 7;
+}

package/proto/decentraland/sdk/components/video_player.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1043;
+
+message PBVideoPlayer {
+   // which file to load
+  string src = 1;
+
+  optional bool playing = 2; // default true
+  optional float position = 3; // default 0.0
+  optional float volume = 4; // default 1.0
+  optional float playback_rate = 5; // default 1.0
+  optional bool loop = 6; // default false
+  // either the audio will be global or spatial (default: false)
+  // global: plays the same way for every listener. It is not affected by distance, direction, or position.
+  // spatial: changes depending on where the listener is relative to the sound source
+  optional bool spatial = 7;
+  // Within the min distance the audio will cease to grow louder in volume (default: 0)
+  optional float spatial_min_distance = 8;
+  // The distance where sound either becomes inaudible or stops attenuation (default: 60)
+  optional float spatial_max_distance = 9;
+}

package/proto/decentraland/sdk/components/virtual_camera.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/camera_transition.proto";
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1076;
+
+// PBVirtualCamera represents a camera to be used at some point in time during the scene execution
+// * The defaultTransition represents the transition TOWARDS this camera. If there is none, it's treated as
+// an 'instant' transition (like using speed/time = 0)
+// * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from 
+// the holding entity transform).
+// * The fov defines the Field of View of the virtual camera
+message PBVirtualCamera {
+  optional common.CameraTransition default_transition = 1;
+  optional uint32 look_at_entity = 2;
+  optional float fov = 3; // default: 60
+}

package/proto/decentraland/sdk/components/visibility_component.proto

@@ -6,4 +6,11 @@ option (common.ecs_component_id) = 1081;
 
 message PBVisibilityComponent {
     optional bool visible = 1; // default=true
+    
+    // Propagation follows certain rules:
+    // - Any own visibility component takes priority
+    // - If no own visibility component, visibility is determined by visibility of the nearest parent with propagate = true
+    // - If no own component and no parent with propagate = true, visibility is "visible"
+    // - Visibility is always updated, whenever hierarchy, parent component or own component changes
+    optional bool propagate_to_children = 2; // default=false
 }

package/proto/decentraland/sdk/development/local_development.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package decentraland.sdk.development;
+
+// ts code & main.crdt updates
+message UpdateScene {
+  string scene_id = 1;
+}
+
+enum UpdateModelType {
+  UMT_CHANGE = 0;
+  UMT_REMOVE = 1;
+}
+
+// .glb & .gltf model udpates
+message UpdateModel {
+  string scene_id = 1;
+  string src = 2;
+  string hash = 3;
+  UpdateModelType type = 4;
+}
+
+message WsSceneMessage {
+  oneof message {
+    // direction: scene -> explorer
+    UpdateScene update_scene = 1;
+    UpdateModel update_model = 2;
+  }
+}