@dcl/protocol 1.0.0-10047077926.commit-ea61304 → 1.0.0-10170032882.commit-971bcef

package/proto/decentraland/sdk/components/avatar_modifier_area.proto

@@ -23,6 +23,8 @@ message PBAvatarModifierArea {
   decentraland.common.Vector3 area = 1;      // the 3D size of the region
   repeated string exclude_ids = 2;           // user IDs that can enter and remain unaffected
   repeated AvatarModifierType modifiers = 3; // list of modifiers to apply
+  optional AvatarMovementSettings movement_settings = 4;
+  optional bool use_collider_range = 5;      // if true, the player will be considered inside the area when they are within 0.3m of the area. default true
 }
 
 // AvatarModifierType is an effect that should be applied to avatars inside the region.
@@ -30,3 +32,22 @@ enum AvatarModifierType {
   AMT_HIDE_AVATARS = 0;      // avatars are invisible
   AMT_DISABLE_PASSPORTS = 1; // selecting (e.g. clicking) an avatar will not bring up their profile.
 }
+
+message AvatarMovementSettings {
+  optional AvatarControlType control_mode = 1;
+  // if not explicitly set, the following properties default to user's preference settings
+  optional float run_speed = 2;              // speed the player moves at, in m/s
+  optional float friction = 3;               // how fast the player gets up to speed or comes to rest. higher = more responsive
+  optional float gravity = 4;                // how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative
+  optional float jump_height = 5;            // how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible
+  optional float max_fall_speed = 6;         // max fall speed in m/s. should normally be negative
+  optional float turn_speed = 7;             // speed the player turns in tank mode, in radians/s
+  optional float walk_speed = 8;             // speed the player walks at, in m/s
+  optional bool allow_weighted_movement = 9; // whether to allow player to move at a slower speed (e.g. with a walk-key or when using a gamepad/joystick). defaults to true  
+}
+
+enum AvatarControlType {
+  CCT_NONE = 0;     // avatar cannot move
+  CCT_RELATIVE = 1; // avatar moves relative to the camera origin
+  CCT_TANK = 2;     // avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player
+}

package/proto/decentraland/sdk/components/camera_mode_area.proto

@@ -9,7 +9,7 @@ import "decentraland/sdk/components/common/id.proto";
 option (common.ecs_component_id) = 1071;
 
 // The CameraModeArea component can be attached to an Entity to define a region of space where 
-// the player's camera mode (1st-person or 3rd-person) is overridden.
+// the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
 //
 // The Entity's Transform position determines the center-point of the region, while its size is 
 // given as a vector in the `area` property below. The Transform rotation is applied, but the scale 
@@ -19,7 +19,26 @@ option (common.ecs_component_id) = 1071;
 //
 // Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
 // is actually a 3D volume.
+//
+// When mode is set to CtCinematic, the cinematic_settings field must also be provided.
 message PBCameraModeArea {
-  decentraland.common.Vector3 area = 1; // the 3D size of the region
-  common.CameraType mode = 2;           // the camera mode to enforce
+  decentraland.common.Vector3 area = 1;                       // the 3D size of the region
+  common.CameraType mode = 2;                                 // the camera mode to enforce
+  optional CinematicSettings cinematic_settings = 3;
+  optional bool use_collider_range = 4;                       // if true, the player will be considered inside the area when they are within 0.3m of the area. default true
+}
+
+message CinematicSettings {
+  uint32 camera_entity = 1;           // Entity that defines the cinematic camera transform.
+                                      // Position -> camera's position
+                                      // Rotation -> camera's direction
+                                      // scale.z -> zoom level
+                                      // scale.x and scale.y -> unused
+  optional bool allow_manual_rotation = 2; // whether the user can move the camera's rotation. default false
+  optional float yaw_range = 3;       // how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted
+  optional float pitch_range = 4;     // how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted
+                                      // note: cameras can never look up/down further than Vec3::Y
+  optional float roll_range = 5;      // how far the camera can rotate around the z-axis / tilt, in radians. default unrestricted
+  optional float zoom_min = 6;        // minimum zoom level. must be greater than 0. defaults to the input zoom level
+  optional float zoom_max = 7;        // maximum zoom level. must be greater than 0. defaults to the input zoom level
 }

package/proto/decentraland/sdk/components/gltf_container_loading_state.proto

@@ -10,4 +10,17 @@ import "decentraland/sdk/components/common/loading_state.proto";
 // the current state of the GltfContainer of an entity.
 message PBGltfContainerLoadingState {
   common.LoadingState current_state = 1;
+  repeated string node_paths = 2; // all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents
+  repeated string mesh_names = 3; // all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY`
+                                  // where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may 
+                                  // conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
+  repeated string material_names = 4; // all materials in the gltf. unnamed materials will be auto-assigned a name of the form `MaterialX` where
+                                      // X is the material index. note this may conflict with manually named materials - to avoid any issues make
+                                      // sure all your materials are explicitly named.
+  repeated string skin_names = 5; // all mesh skins in the gltf. unnamed skins will be auto-assigned a name of the form `SkinX` where
+                                  // X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all 
+                                  // your skins are explicitly named.
+  repeated string animation_names = 6; // all animations in the gltf. unnamed animations will be auto-assigned a name of the form `AnimationX` where
+                                       // X is the animation index. note this may conflict with manually named anims - to avoid any issues make sure all 
+                                       // your animations are explicitly named.
 }

package/proto/decentraland/sdk/components/gltf_node.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1045;
+
+// a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
+// This component must be added to a direct child of an entity with a PbGltfContainer component, or
+// to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
+// in the parent.
+// The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
+// 
+// The renderer will attach a PbGltfNodeState to the entity describing the state. Once the state is `GNS_READY`, 
+// - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
+// - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
+// - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
+// - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
+//
+// After creation, if an animation moves the node, the `Transform` will be updated.
+//
+// From the scene, you can modify various components to alter the gltf node:
+// - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node), 
+//   regardless of any intermediate gltf node hierarchy.
+//   If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
+// - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
+// - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
+// - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
+// - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
+//   used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the 
+//   PbMaterial will be maintained.
+//
+// The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible: 
+// - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
+//   change the state to `GNS_FAILED`.
+// - deleting the scene entity will not delete the gltf node.
+//
+// Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material 
+// are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and 
+// the gltf node will also be displayed.
+message PBGltfNode {
+  string path = 1; // the path of the target node in the Gltf.
+}

package/proto/decentraland/sdk/components/gltf_node_state.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1046;
+
+// See the details of the GltfNode component for more information.
+
+// The state of a linked gltf node.
+// If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
+message PBGltfNodeState {
+    GltfNodeStateValue state = 1;
+    optional string error = 2;
+}
+
+enum GltfNodeStateValue {
+    GNSV_PENDING = 0;
+    GNSV_FAILED = 1;
+    GNSV_READY = 2;
+}

package/proto/decentraland/sdk/components/material.proto

@@ -53,5 +53,16 @@ message PBMaterial {
     UnlitMaterial unlit = 1;
     PbrMaterial pbr = 2;
   }
+
+  message GltfMaterial {
+    string gltf_src = 1;
+    string name = 2;
+  }
   
+  // A gltf material that may provide additional features not supported by the PbMaterial fields.
+  // If both gltf and material fields are provided, the gltf will be used only for extended features not 
+  // supported by the PbMaterial.
+  // If this is provided and the `material` field is not provided, the renderer will update the material
+  // field with data that reflects the gltf material once it is loaded.
+  optional GltfMaterial gltf = 3;
 }

package/proto/decentraland/sdk/components/mesh_collider.proto

@@ -30,6 +30,12 @@ message PBMeshCollider {
   // SphereMesh is a sphere shape that contains the Entity.
   message SphereMesh {}
 
+  // A collider constructed from a Gltf Mesh.
+  message GltfMesh {
+    string gltf_src = 1; // the GLTF file path as listed in the scene's manifest.
+    string name = 2; // the name of the mesh asset
+  }
+
   optional uint32 collision_mask = 1; // enabled ColliderLayers (default CL_POINTER | CL_PHYSICS)
 
   oneof mesh {
@@ -37,6 +43,7 @@ message PBMeshCollider {
     SphereMesh sphere = 3;
     CylinderMesh cylinder = 4;
     PlaneMesh plane = 5;
+    GltfMesh gltf = 6;
   }
 }
 
@@ -59,4 +66,4 @@ enum ColliderLayer {
   CL_CUSTOM6 = 8192;
   CL_CUSTOM7 = 16384;
   CL_CUSTOM8 = 32768;
-}
+}

package/proto/decentraland/sdk/components/mesh_renderer.proto

@@ -5,13 +5,11 @@ import "decentraland/sdk/components/common/id.proto";
 option (common.ecs_component_id) = 1018;
 
 // The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a 
-// plane, a sphere or a cylinder.
+// plane, a sphere, a cylinder, or a Gltf mesh.
 //
 // The cube and plane variants can include a UV texture mapping, so specific areas of a material 
 // texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
 // `float` coordinates, one for each corner of each side of each face.
-//
-// More complex shapes require the use of a `GltfContainer` component.
 message PBMeshRenderer {
     
     // BoxMesh renders a prism shape.
@@ -34,10 +32,17 @@ message PBMeshRenderer {
     message SphereMesh {
     }
 
+    // A mesh from a Gltf.
+    message GltfMesh {
+        string gltf_src = 1; // the GLTF file path as listed in the scene's manifest.
+        string name = 2;  // the name of the mesh asset
+    }
+
     oneof mesh {
         BoxMesh box = 1;
         SphereMesh sphere = 2;
         CylinderMesh cylinder = 3;
         PlaneMesh plane = 4;
+        GltfMesh gltf = 5;
     }
 }

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) = 1097;
+
+message PBUiScrollResult {
+  decentraland.common.Vector2 value = 1;
+}

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

@@ -23,4 +23,7 @@ message PBUiText {
   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)
+  
+  optional float outline_width = 7;              // width of the outline (default: 0)
+  optional decentraland.common.Color4 outline_color = 8; // RGBA color of the outline (default: opaque black)
 }

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

@@ -3,6 +3,7 @@ syntax = "proto3";
 package decentraland.sdk.components;
 
 import "decentraland/sdk/components/common/id.proto";
+import "decentraland/common/vectors.proto";
 
 option (common.ecs_component_id) = 1050;
 
@@ -79,6 +80,20 @@ enum PointerFilterMode {
   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 = 1;
   int32 right_of = 2;
@@ -145,4 +160,10 @@ message PBUiTransform {
   float padding_bottom = 51;
   
   optional PointerFilterMode pointer_filter = 52; // default: PointerFilterMode.PFM_NONE
+  optional float opacity = 53; // default: 1
+
+  optional string element_id = 54; // default empty
+
+  optional ScrollPositionValue scroll_position = 55; // default position=(0,0)
+  optional ShowScrollBar scroll_visible = 56; // default ShowScrollBar.SSB_BOTH
 }

package/public/sdk-components.proto

@@ -16,6 +16,8 @@ import public "decentraland/sdk/components/camera_mode.proto";
 import public "decentraland/sdk/components/engine_info.proto";
 import public "decentraland/sdk/components/gltf_container.proto";
 import public "decentraland/sdk/components/gltf_container_loading_state.proto";
+import public "decentraland/sdk/components/gltf_node.proto";
+import public "decentraland/sdk/components/gltf_node_state.proto";
 import public "decentraland/sdk/components/material.proto";
 import public "decentraland/sdk/components/mesh_collider.proto";
 import public "decentraland/sdk/components/mesh_renderer.proto";