@dcl/protocol 1.0.0-2611981047.commit-6f422a3 → 1.0.0-26120507017.commit-56ef588

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

@@ -0,0 +1,34 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+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 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_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

@@ -0,0 +1,26 @@
+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) = 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;                              // 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

@@ -0,0 +1,178 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/common/colors.proto";
+
+option (common.ecs_component_id) = 1050;
+
+enum YGPositionType {
+  YGPT_RELATIVE = 0;
+  YGPT_ABSOLUTE = 1;
+}
+
+enum YGAlign {
+  YGA_AUTO = 0;
+  YGA_FLEX_START = 1;
+  YGA_CENTER = 2;
+  YGA_FLEX_END = 3;
+  YGA_STRETCH = 4;
+  YGA_BASELINE = 5;
+  YGA_SPACE_BETWEEN = 6;
+  YGA_SPACE_AROUND = 7;
+}
+
+enum YGUnit {
+  YGU_UNDEFINED = 0;
+  YGU_POINT = 1;
+  YGU_PERCENT = 2;
+  YGU_AUTO = 3;
+}
+
+enum YGFlexDirection {
+  YGFD_ROW = 0;
+  YGFD_COLUMN = 1;
+  YGFD_COLUMN_REVERSE = 2;
+  YGFD_ROW_REVERSE = 3;
+}
+
+enum YGWrap {
+  YGW_NO_WRAP = 0;
+  YGW_WRAP = 1;
+  YGW_WRAP_REVERSE = 2;
+}
+
+enum YGJustify {
+  YGJ_FLEX_START = 0;
+  YGJ_CENTER = 1;
+  YGJ_FLEX_END = 2;
+  YGJ_SPACE_BETWEEN = 3;
+  YGJ_SPACE_AROUND = 4;
+  YGJ_SPACE_EVENLY = 5;
+}
+
+enum YGOverflow {
+  YGO_VISIBLE = 0;
+  YGO_HIDDEN = 1;
+  YGO_SCROLL = 2;
+}
+
+enum YGDisplay {
+  YGD_FLEX = 0;
+  YGD_NONE = 1;
+}
+
+enum YGEdge {
+  YGE_LEFT = 0;
+  YGE_TOP = 1;
+  YGE_RIGHT = 2;
+  YGE_BOTTOM = 3;
+  YGE_START = 4;
+  YGE_END = 5;
+  YGE_HORIZONTAL = 6;
+  YGE_VERTICAL = 7;
+  YGE_ALL = 8;
+}
+
+enum PointerFilterMode {
+  PFM_NONE = 0;
+  PFM_BLOCK = 1;
+}
+
+message PBUiTransform {
+  int32 parent = 1;
+  int32 right_of = 2;
+
+  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
+
+  YGPositionType position_type = 7; // YGPositionType.YGPT_RELATIVE
+
+  YGAlign align_self = 8; // YGAlign.YGA_AUTO
+  YGFlexDirection flex_direction = 9; // YGFlexDirection.YGFD_ROW
+  YGJustify justify_content = 10; // YGJustify.YGJ_FLEX_START
+
+  YGOverflow overflow = 11; // YGOverflow.YGO_VISIBLE
+  YGDisplay display = 12; // YGDisplay.YGD_FLEX
+
+  YGUnit flex_basis_unit = 13; // YGUnit.YGU_UNDEFINED
+  float flex_basis = 14;
+
+  float flex_grow = 15;
+
+  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 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,16 @@
+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).
+message PBVirtualCamera {
+  optional common.CameraTransition default_transition = 1;
+  optional uint32 look_at_entity = 2;
+}

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

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+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;
+  }
+}