@dcl/protocol 1.0.0-4468031496.commit-eace17b → 1.0.0-4493564897.commit-c858f8a

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

@@ -42,7 +42,21 @@ message PBMeshCollider {
 
 // ColliderLayer determines the kind of collision to detect, in OR-able bit flag form.
 enum ColliderLayer {
-  CL_NONE = 0;    // no collisions
-  CL_POINTER = 1; // collisions with the player's pointer ray (e.g. mouse cursor hovering)
-  CL_PHYSICS = 2; // colission with Avatars
+  CL_NONE = 0;           // no collisions
+  CL_POINTER = 1;        // collisions with the player's pointer ray (e.g. mouse cursor hovering)
+  CL_PHYSICS = 2;        // collision affecting your player's physics i.e. walls, floor, moving platfroms
+  CL_VISIBLE_MESHES = 4; // all visible meshes, use with extreme care since the performance penalty is high
+  CL_RESERVED2 = 8;
+  CL_RESERVED3 = 16;
+  CL_RESERVED4 = 32;
+  CL_RESERVED5 = 64;
+  CL_RESERVED6 = 128;
+  CL_CUSTOM1 = 256;
+  CL_CUSTOM2 = 512;
+  CL_CUSTOM3 = 1024;
+  CL_CUSTOM4 = 2048;
+  CL_CUSTOM5 = 4096;
+  CL_CUSTOM6 = 8192;
+  CL_CUSTOM7 = 16384;
+  CL_CUSTOM8 = 32768;
 }

package/proto/decentraland/sdk/components/pointer_events.proto

@@ -29,17 +29,9 @@ message PBPointerEvents {
   }
 
   message Entry {
-    PointerEventType event_type = 1; // the kind of interaction to detect
+    common.PointerEventType event_type = 1; // the kind of interaction to detect
     Info event_info = 2;             // additional configuration for this detection
   }
 
   repeated Entry pointer_events = 1; // the list of relevant events to detect
 }
-
-// PointerEventType is a kind of interaction that can be detected.
-enum PointerEventType {
-  PET_UP = 0;
-  PET_DOWN = 1;
-  PET_HOVER_ENTER = 2;
-  PET_HOVER_LEAVE = 3;
-}

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

@@ -4,16 +4,15 @@ package decentraland.sdk.components;
 
 import "decentraland/sdk/components/common/id.proto";
 import "decentraland/sdk/components/common/input_action.proto";
-import "decentraland/sdk/components/pointer_events.proto";
-import "decentraland/sdk/components/raycast_result.proto";
+import "decentraland/sdk/components/common/raycast_hit.proto";
 
 option (common.ecs_component_id) = 1063;
 
 // renderer append a new object of this in each command, there can be many commands per frames
 message PBPointerEventsResult {
   common.InputAction button = 1; // identifier of the input
-  RaycastHit hit = 2;
-  PointerEventType state = 4;
-  int32 timestamp = 5; // could be a Lamport timestamp
-  optional float analog = 6; // if the input is analog then we store it here
+  common.RaycastHit hit = 2;
+  common.PointerEventType state = 4;
+  uint32 timestamp = 5;          // could be a Lamport timestamp
+  optional float analog = 6;     // if the input is analog then we store it here
 }

package/proto/decentraland/sdk/components/raycast.proto

@@ -7,17 +7,52 @@ import "decentraland/sdk/components/common/id.proto";
 
 option (common.ecs_component_id) = 1067;
 
+// The PBRaycast component and PBRaycastResult are defined in https://adr.decentraland.org/adr/ADR-200
+//
 // The Raycast component allows scenes to request raycasting from the game engine. The results will
 // be available in a RaycastResult component set later on the same Entity.
 message PBRaycast {
-  decentraland.common.Vector3 origin = 2;    // the starting point of the ray in 3D space
-  decentraland.common.Vector3 direction = 3; // the direction of the ray in 3D space
-  float max_distance = 4;                    // the maximum length of the ray
-  RaycastQueryType query_type = 5;           // the RaycastQueryType behavior (see above)
+  // Correlation ID, defined by the scene and used internally by the scene
+  optional uint32 timestamp = 1;
+
+  // How much to offset the starting point of the ray, relative to the entity's transform.
+  // Defaults to vec3(0,0,0)
+  optional decentraland.common.Vector3 origin_offset = 2;
+
+  oneof direction {
+    // The direction of the ray in local coordinates (relative to the origin point)
+    decentraland.common.Vector3 local_direction = 6;
+
+    // The direction of the ray in global coordinates (relative to origin)
+    decentraland.common.Vector3 global_direction = 3;
+
+    // Target coordinates of the raycast, in global coordinates
+    decentraland.common.Vector3 global_target = 7;
+
+    // Will point to the final world position of another entity
+    uint32 target_entity = 10;
+  }
+
+  // Maximum length of the ray in virtual meters (global space)
+  float max_distance = 4;
+
+  // the RaycastQueryType behavior
+  RaycastQueryType query_type = 5;
+
+  // Indicates the renderer to perform the raycast on every scene tick (ADR-148),
+  // otherwise it will be performed only once, defaults to false
+  optional bool continuous = 8;
+
+  // Collision mask, by default all bits are 1 (0xFFFF_FFFF)
+  optional uint32 collision_mask = 9;
 }
 
 // RaycastQueryType indicates whether the ray should stop on the first collition, or continue.
 enum RaycastQueryType {
+  // Pick the first (not necessarily the closest) hit within the range
   RQT_HIT_FIRST = 0;
+  // Pick all hits within the range
   RQT_QUERY_ALL = 1;
+  // Do not perform the raycast, only set the raycast result with empty hits
+  RQT_NONE = 2;
 }

package/proto/decentraland/sdk/components/raycast_result.proto

@@ -1,30 +1,20 @@
 syntax = "proto3";
 package decentraland.sdk.components;
 
-import "decentraland/sdk/components/common/id.proto";
 import "decentraland/common/vectors.proto";
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/common/raycast_hit.proto";
 
 option (common.ecs_component_id) = 1068;
 
+// The PBRaycast component and PBRaycastResult are defined in https://adr.decentraland.org/adr/ADR-200
+//
 // The RaycastResult component is added to an Entity when the results of a previously attached
-// Raycast component are available. It contains information about the ray and any objects it 
+// Raycast component are available. It contains information about the ray and any objects it
 // collided with.
 message PBRaycastResult {
-  int32 timestamp = 1;                       // the timestamp of the Raycast component addition
-  decentraland.common.Vector3 origin = 2;    // the starting point of the ray
-  decentraland.common.Vector3 direction = 3; // the direction vector of the ray
-  repeated RaycastHit hits = 4;              // zero or more hits
+  optional uint32 timestamp = 1;                 // timestamp is a correlation id, copied from the PBRaycast
+  decentraland.common.Vector3 global_origin = 2; // the starting point of the ray in global coordinates
+  decentraland.common.Vector3 direction = 3;     // the direction vector of the ray in global coordinates
+  repeated decentraland.sdk.components.common.RaycastHit hits = 4; // zero or more hits
 }
-
-// RaycastHit contains information about the intersection of a ray with a mesh.
-message RaycastHit {
-  // Position will be relative to the scene  
-  decentraland.common.Vector3 position = 1;   // the intersection point
-  decentraland.common.Vector3 origin = 2;     // the starting point of the ray
-  decentraland.common.Vector3 direction = 3;  // the direction vector of the ray
-  decentraland.common.Vector3 normal_hit = 4; // the entry vector of the ray into the collision mesh
-  
-  float length = 5;              // the distance between the ray origin and the hit position
-  optional string mesh_name = 6; // (unused) mesh ID if collision happened inside a GltfContainer
-  optional int64 entity_id = 7;  // the ID of the Entity that has the impacted mesh attached
-}