@dcl/protocol 1.0.0-3373991894.commit-8aa3a49 → 1.0.0-33861349213.commit-76445a6

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

@@ -8,26 +8,38 @@ import "decentraland/sdk/components/common/texts.proto";
 
 option (common.ecs_component_id) = 1030;
 
+// The TextShape component renders customizable floating text.
+//
+// The position and rotation of the text are defined by the Entity's Transform, while its size
+// can either scale with the Transform or be fixed by a font size.
+//
+// Several options can be configured, including color, padding, line spacing and drop shadows.
 message PBTextShape {
-  string text = 1;
-  optional common.Font font = 2; // default=F_SANS_SERIF
-  optional float font_size = 3; // default=10
-  optional bool font_auto_size = 4;
-  optional common.TextAlignMode text_align = 5; // default=TAM_CENTER_CENTER
-  optional float width = 6; // default=1
-  optional float height = 7; // default=1
-  optional float padding_top = 8;
-  optional float padding_right = 9;
-  optional float padding_bottom = 10;
-  optional float padding_left = 11;
-  optional float line_spacing = 12;
-  optional int32 line_count = 13;
-  optional bool text_wrapping = 14;
-  optional float shadow_blur = 15;
-  optional float shadow_offset_x = 16;
-  optional float shadow_offset_y = 17;
-  optional float outline_width = 18;
-  optional decentraland.common.Color3 shadow_color = 19; // default=(1.0,1.0,1.0)
-  optional decentraland.common.Color3 outline_color = 20; // default=(1.0,1.0,1.0)
-  optional decentraland.common.Color4 text_color = 21; // default=(1.0,1.0,1.0)
+  string text = 1; // the content
+
+  optional common.Font font = 2;    // the font (default F_SANS_SERIF)
+  optional float font_size = 3;     // the font size (default 10)
+  optional bool font_auto_size = 4; // override `font_size` to automatically fit in `width`/`height`
+  
+  optional common.TextAlignMode text_align = 5; // X and Y alignment (default TAM_CENTER_CENTER)
+
+  optional float width = 6;           // available horizontal space (default 1)
+  optional float height = 7;          // available vertical space (default 1)
+  optional float padding_top = 8;     // distance from text to top border (default 0)
+  optional float padding_right = 9;   // distance from text to right border (default 0)
+  optional float padding_bottom = 10; // distance from text to bottom border (default 0)
+  optional float padding_left = 11;   // distance from text to left border (default 0)
+  
+  optional float line_spacing = 12; // extra distance between lines (default 0)
+  optional int32 line_count = 13;   // maximum number of lines to display
+  optional bool text_wrapping = 14; // wrap text when the border is reached (default false)
+
+  optional float shadow_blur = 15;     // blurriness of the drop shadow (default 0)
+  optional float shadow_offset_x = 16; // horizontal length of the shadow (default 0)
+  optional float shadow_offset_y = 17; // vertical length of the shadow (default 0)
+  optional float outline_width = 18;   // width of the stroke outlining each letter (default 0)
+
+  optional decentraland.common.Color3 shadow_color = 19;  // drop shadow color (default [1.0, 1.0, 1.0])
+  optional decentraland.common.Color3 outline_color = 20; // outline stroke color (default [1.0, 1.0, 1.0])
+  optional decentraland.common.Color4 text_color = 21;    // text color (default [1.0, 1.0, 1.0])
 }

package/proto/decentraland/sdk/components/touch_screen_controls.proto

@@ -0,0 +1,38 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/common/input_action.proto";
+import "decentraland/common/texture.proto";
+option (common.ecs_component_id) = 1218;
+
+// 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`).
+message PBTouchScreenControls {
+    // Per-button configuration. A button not listed here keeps its default (shown).
+    message TouchInput {
+        common.InputAction input_action = 1; // which on-screen button this configures
+        bool hide = 2;                        // hide this button (default: shown)
+        // Override the button glyph with this texture. For the jump button it replaces all
+        // of its dynamic states (jump / double-jump / glide).
+        optional decentraland.common.TextureUnion icon = 3;
+    }
+
+    repeated TouchInput touch_inputs = 1;
+    // 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.
+    optional common.InputAction main_action = 2;
+    bool hide_joystick = 3; // hide the native virtual joystick
+    bool hide_crosshair = 4; // hide the on-screen crosshair / reticle
+}

package/proto/decentraland/sdk/components/trigger_area.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1060;
+
+// The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
+// when entities enter this component's defined area.
+//
+// ADR: https://github.com/decentraland/adr/blob/2b30a5e2b4f359a7c22a68fb827db282f6e5f887/content/ADR-258-trigger-areas.md
+//
+// The area size and rotation is defined by the Entity's Transform.
+message PBTriggerArea {
+  optional TriggerAreaMeshType mesh = 1;         // default: MT_BOX
+  optional uint32 collision_mask = 2; // default: CL_PLAYER
+}
+
+enum TriggerAreaMeshType {
+  TAMT_BOX = 0;
+  TAMT_SPHERE = 1;
+}

package/proto/decentraland/sdk/components/trigger_area_result.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/vectors.proto";
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1061;
+
+// The PBTriggerAreaResult component is used to transport the trigger collision event data for the PBTriggerArea component.
+// ADR: https://github.com/decentraland/adr/blob/2b30a5e2b4f359a7c22a68fb827db282f6e5f887/content/ADR-258-trigger-areas.md
+message PBTriggerAreaResult {
+  // Trigger data object
+  message Trigger {
+    uint32 entity = 1;                                          // The entity that triggered the Trigger Area
+    uint32 layers = 2;                                          // The collision layermask of the entity that triggered the Trigger Area
+    decentraland.common.Vector3 position = 3;                   // The position of the entity that triggered the trigger
+    decentraland.common.Quaternion rotation = 4;                // The rotation of the entity that triggered the trigger
+    decentraland.common.Vector3 scale = 5;                      // The scale of the entity that triggered the trigger
+  }
+  
+  uint32 triggered_entity = 1;                                  // The entity that was triggered (this is the entity that owns the trigger area)
+  decentraland.common.Vector3 triggered_entity_position = 2;    // The position of the triggered entity at the time of the trigger
+  decentraland.common.Quaternion triggered_entity_rotation = 3; // The rotation of the triggered entity at the time of the trigger
+  TriggerAreaEventType event_type = 4;                          // The state of the trigger event (ENTER, STAY, EXIT)
+  uint32 timestamp = 5;                                         // The timestamp of the trigger event
+  Trigger trigger = 6;
+}
+
+enum TriggerAreaEventType {
+  TAET_ENTER = 0;
+  TAET_STAY = 1;
+  TAET_EXIT = 2;
+}

package/proto/decentraland/sdk/components/tween.proto

@@ -0,0 +1,117 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/vectors.proto";
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1102;
+
+message PBTween {
+  float duration = 1; // in milliseconds
+  EasingFunction easing_function = 2;
+
+  oneof mode {
+    Move move = 3;
+    Rotate rotate = 4;
+    Scale scale = 5;
+    TextureMove texture_move = 8;
+    RotateContinuous rotate_continuous = 9;
+    MoveContinuous move_continuous = 10;
+    TextureMoveContinuous texture_move_continuous = 11;
+    MoveRotateScale move_rotate_scale = 12;
+  }
+
+  optional bool playing = 6; // default true (pause or running)
+  optional float current_time = 7; // between 0 and 1
+}
+
+message Move {
+  decentraland.common.Vector3 start = 1;
+  decentraland.common.Vector3 end = 2;
+  optional bool face_direction = 3;
+}
+
+message Rotate {
+  decentraland.common.Quaternion start = 1;
+  decentraland.common.Quaternion end = 2;
+}
+
+message Scale {
+  decentraland.common.Vector3 start = 1;
+  decentraland.common.Vector3 end = 2;
+}
+
+message MoveRotateScale {
+  decentraland.common.Vector3 position_start = 1;
+  decentraland.common.Vector3 position_end = 2;
+  decentraland.common.Quaternion rotation_start = 3;
+  decentraland.common.Quaternion rotation_end = 4;
+  decentraland.common.Vector3 scale_start = 5;
+  decentraland.common.Vector3 scale_end = 6;
+}
+
+// This tween mode allows to move the texture of a PbrMaterial or UnlitMaterial.
+// You can also specify the movement type (offset or tiling)
+message TextureMove {
+  decentraland.common.Vector2 start = 1;
+  decentraland.common.Vector2 end = 2;
+  optional TextureMovementType movement_type = 3; // default = TextureMovementType.TMT_OFFSET
+}
+
+message RotateContinuous {
+  decentraland.common.Quaternion direction = 1;
+  float speed = 2;
+}
+
+message MoveContinuous {
+  decentraland.common.Vector3 direction = 1;
+  float speed = 2;
+}
+
+message TextureMoveContinuous {
+  decentraland.common.Vector2 direction = 1;
+  float speed = 2;
+  optional TextureMovementType movement_type = 3; // default = TextureMovementType.TMT_OFFSET
+}
+
+enum TextureMovementType {
+  TMT_OFFSET = 0; // default = TextureMovementType.TMT_OFFSET
+  TMT_TILING = 1;
+}
+
+// Implementation guidelines for these easing functions can be found
+// at https://github.com/ai/easings.net/blob/6fcd5f852a470bf1a7890e8178afa0f471d5f2ec/src/easings/easingsFunctions.ts
+enum EasingFunction {
+  EF_LINEAR = 0; // default
+  EF_EASEINQUAD = 1;
+  EF_EASEOUTQUAD = 2;
+  EF_EASEQUAD = 3;
+  EF_EASEINSINE = 4;
+  EF_EASEOUTSINE = 5;
+  EF_EASESINE = 6;
+  EF_EASEINEXPO = 7;
+  EF_EASEOUTEXPO = 8;
+  EF_EASEEXPO = 9;
+  EF_EASEINELASTIC = 10;
+  EF_EASEOUTELASTIC = 11;
+  EF_EASEELASTIC = 12;
+  EF_EASEINBOUNCE = 13;
+  EF_EASEOUTBOUNCE = 14;
+  EF_EASEBOUNCE = 15;
+  EF_EASEINCUBIC = 16;
+  EF_EASEOUTCUBIC = 17;
+  EF_EASECUBIC = 18;
+  EF_EASEINQUART = 19;
+  EF_EASEOUTQUART = 20;
+  EF_EASEQUART = 21;
+  EF_EASEINQUINT = 22;
+  EF_EASEOUTQUINT = 23;
+  EF_EASEQUINT = 24;
+  EF_EASEINCIRC = 25;
+  EF_EASEOUTCIRC = 26;
+  EF_EASECIRC = 27;
+  EF_EASEINBACK = 28;
+  EF_EASEOUTBACK = 29;
+  EF_EASEBACK = 30;
+}

package/proto/decentraland/sdk/components/tween_sequence.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/tween.proto";
+
+option (common.ecs_component_id) = 1104;
+
+message PBTweenSequence {
+  repeated PBTween sequence = 1;
+  optional TweenLoop loop = 2;
+}
+
+enum TweenLoop {
+  TL_RESTART = 0;
+  TL_YOYO = 1;
+}

package/proto/decentraland/sdk/components/tween_state.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1103;
+
+message PBTweenState {
+  TweenStateStatus state = 1;
+  float current_time = 2; // between 0 and 1
+}
+
+enum TweenStateStatus {
+  TS_ACTIVE = 0;
+  TS_COMPLETED = 1;
+  TS_PAUSED= 2;
+}

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_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,20 @@
+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;
+}

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_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)
 }