@dcl/protocol 1.0.0-2569677750.commit-6ce832a → 1.0.0-2611857113.commit-45ed75b

package/ecs/components/Animator.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1042;
+
+message PBAnimator {
+   repeated PBAnimationState states = 1;
+}
+
+message PBAnimationState {
+  string name = 1;
+  string clip = 2;
+  bool playing = 3;
+  float weight = 4;
+  float speed = 5;
+  bool loop = 6;
+  bool should_reset = 7;
+}

package/ecs/components/AudioSource.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1020;
+
+message PBAudioSource {  
+  bool playing = 1;
+  float volume = 2;
+  bool loop = 3;
+  float pitch = 4;
+  int32 played_at_timestamp = 5;
+  string audio_clip_url = 6;
+}

package/ecs/components/AudioStream.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1021;
+
+message PBAudioStream {  
+  bool playing = 1;
+  float volume = 2;
+  string url = 3;
+}

package/ecs/components/AvatarModifierArea.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1070;
+import "common/Vector3.proto";
+
+message PBAvatarModifierArea {
+  Vector3 area = 1;
+  repeated string exclude_ids = 2;
+  repeated Modifier modifiers = 3;
+  enum Modifier {
+    HIDE_AVATARS = 0;
+    DISABLE_PASSPORTS = 1;
+  }
+}

package/ecs/components/BoxShape.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1013;
+
+message PBBoxShape {  
+  bool with_collisions = 1;
+  bool is_pointer_blocker = 2;
+  bool visible = 3;
+  repeated float uvs = 4;
+}

package/ecs/components/CameraModeArea.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1071;
+import "common/Vector3.proto";
+
+message PBCameraModeArea {
+  Vector3 area = 1;
+  CameraMode mode = 2;
+  enum CameraMode {
+    FIRST_PERSON = 0;
+    THIRD_PERSON = 1;
+  }
+}

package/ecs/components/CylinderShape.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1016;
+
+message PBCylinderShape {  
+  bool with_collisions = 1;
+  bool is_pointer_blocker = 2;
+  bool visible = 3;
+  float radius_top = 4;
+  float radius_bottom = 5;
+}

package/ecs/components/GLTFShape.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1041;
+
+message PBGLTFShape {
+  bool with_collisions = 1;
+  bool is_pointer_blocker = 2;
+  bool visible = 3;
+  string src = 4;
+}

package/ecs/components/NFTShape.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1040;
+
+import "common/Color3.proto";
+
+message PBNFTShape {
+  bool with_collisions = 1;
+  bool is_pointer_blocker = 2;
+  bool visible = 3;
+  string src = 4;
+  string asset_id = 5;
+  int32 style = 6;
+  Color3 color = 7;
+}

package/ecs/components/OnPointerDown.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1060;
+
+message PBOnPointerDown {
+  int32 button = 1;
+  string hover_text = 2;
+  float distance = 3;
+  bool show_feedback = 4;
+}

package/ecs/components/OnPointerDownResult.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1066;
+import "common/Vector3.proto";
+
+message PBOnPointerDownResult {
+  int32 button = 2;
+  string meshName = 3;
+  Vector3 origin = 4;
+  Vector3 direction = 5;
+  Vector3 point = 6;
+  Vector3 normal = 7;
+  float distance = 8;
+  int32 timestamp = 9;
+}

package/ecs/components/OnPointerUp.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1061;
+
+message PBOnPointerUp {
+  int32 button = 1;
+  string hover_text = 2;
+  float distance = 3;
+  bool show_feedback = 4;
+}

package/ecs/components/OnPointerUpResult.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1065;
+import "common/Vector3.proto";
+
+message PBOnPointerUpResult {
+  int32 button = 2;
+  string meshName = 3;
+  Vector3 origin = 4;
+  Vector3 direction = 5;
+  Vector3 point = 6;
+  Vector3 normal = 7;
+  float distance = 8;
+  int32 timestamp = 9;
+}

package/ecs/components/PlaneShape.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1014;
+
+message PBPlaneShape {  
+  bool with_collisions = 1;
+  bool is_pointer_blocker = 2;
+  bool visible = 3;
+  repeated float uvs = 4;
+}

package/ecs/components/README.md

@@ -0,0 +1,32 @@
+# How to add a new ECS Component with Protocol-Buffers
+
+In this directory, we have all the components with the schema `ComponentName.proto`. `ComponentName` has to be PascalCase, and the `.proto` is the extension that is recognized as protocol-buffer schema.
+
+Inside each proto, we need to have at least this template:
+```proto
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = XXXX;
+
+message PBComponentName {
+    float one_parameter = 1;
+}
+
+```
+
+Some points that must be well-defined:
+- `XXXX` the component ID is a super important property of the component, and it has to be unique at least between proto, otherwise, the code generation will fail.
+- `PBComponentName` the root message has to be the same as the file name with the prefix `PB`
+- `one_parameter` each parameter name has to be snake_case.
+
+
+## Common directory
+The common directory only has to have unambiguous structures like Vector3, Color3, Quaternion, etc. These messages will never change.
+
+## About specific options with other languages
+The definition must be the minimal proto code, and it shouldn't have a specific option to compile on some platform. So if you have to add additional information to the proto, you will be able to run a post-process after the protocol schemas acquisition.
+For example, in the unity-renderer repo, it'll be necessary to add the `csharp_namespace` option but it's the responsibility of this particular implementation. This code option doesn't define how the component is.
+
+# Test component
+If you write a proto and then push, CI will fail because the tests will fail. All the components need to be tested. `@dcl/ecs/test/components` has some examples!

package/ecs/components/SphereShape.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1015;
+
+message PBSphereShape {  
+  bool with_collisions = 1;
+  bool is_pointer_blocker = 2;
+  bool visible = 3;
+}

package/ecs/components/TextShape.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1030;
+
+import "common/Color3.proto";
+
+message PBTextShape {
+  string text = 1;
+  bool visible = 2;
+  string font = 3;
+  float opacity = 4;
+  float font_Size = 5;
+  bool font_autoSize = 6;
+  string h_text_align = 7;
+  string v_text_align = 8;
+  float width = 9;
+  float height = 10;
+  float padding_top = 11;
+  float padding_right = 12;
+  float padding_bottom = 13;
+  float padding_left = 14;
+  float line_spacing = 15;
+  int32 line_count = 16;
+  bool text_wrapping = 17;
+  float shadow_blur = 18;
+  float shadow_offsetX = 19;
+  float shadow_offsetY = 20;
+  float outline_width = 21;
+  Color3 shadow_color = 22;
+  Color3 outline_color = 23;
+  Color3 text_color = 24;
+}

package/ecs/components/Transform.md

@@ -0,0 +1,25 @@
+
+# Transform
+
+Transform is not a protocol-buffer definition, because it uses the native byte-buffer to write directly on the wire. This allows the consumer to copy the message directly on memory and the component be serialized a little bit faster.
+
+```cpp
+// Transform length = 44 
+struct Transform {
+    float positionX;
+    float positionY;
+    float positionZ;
+
+    float rotationX;
+    float rotationY;
+    float rotationZ;
+    float rotationW;
+
+    float scaleX;
+    float scaleY;
+    float scaleZ;
+
+    uint32_t parentEntity;
+};
+```
+- Serialized in big-endian

package/ecs/components/UiTransform.proto

@@ -0,0 +1,159 @@
+syntax = "proto3";
+
+import "common/id.proto";
+option (ecs_component_id) = 1050;
+
+enum YGPositionType {
+  YGPositionTypeStatic = 0;
+  YGPositionTypeRelative = 1;
+  YGPositionTypeAbsolute = 2;
+}
+
+enum YGAlign {
+  YGAlignAuto = 0;
+  YGAlignFlexStart = 1;
+  YGAlignCenter = 2;
+  YGAlignFlexEnd = 3;
+  YGAlignStretch = 4;
+  YGAlignBaseline = 5;
+  YGAlignSpaceBetween = 6;
+  YGAlignSpaceAround = 7;
+}
+
+enum YGUnit {
+  YGUnitUndefined = 0;
+  YGUnitPoint = 1;
+  YGUnitPercent = 2;
+  YGUnitAuto = 3;
+}
+
+enum YGDirection {
+  YGDirectionInherit = 0;
+  YGDirectionLTR = 1;
+  YGDirectionRTL = 2;
+}
+
+enum YGFlexDirection {
+  YGFlexDirectionColumn = 0;
+  YGFlexDirectionColumnReverse = 1;
+  YGFlexDirectionRow = 2;
+  YGFlexDirectionRowReverse = 3;
+}
+
+enum YGWrap {
+  YGWrapNoWrap = 0;
+  YGWrapWrap = 1;
+  YGWrapWrapReverse = 2;
+}
+
+enum YGJustify {
+  YGJustifyFlexStart = 0;
+  YGJustifyCenter = 1;
+  YGJustifyFlexEnd = 2;
+  YGJustifySpaceBetween = 3;
+  YGJustifySpaceAround = 4;
+  YGJustifySpaceEvenly = 5;
+}
+
+enum YGOverflow {
+  YGOverflowVisible = 0;
+  YGOverflowHidden = 1;
+  YGOverflowScroll = 2;
+}
+
+enum YGDisplay {
+  YGDisplayFlex = 0;
+  YGDisplayNone = 1;
+}
+
+enum YGEdge {
+  YGEdgeLeft = 0;
+  YGEdgeTop = 1;
+  YGEdgeRight = 2;
+  YGEdgeBottom = 3;
+  YGEdgeStart = 4;
+  YGEdgeEnd = 5;
+  YGEdgeHorizontal = 6;
+  YGEdgeVertical = 7;
+  YGEdgeAll = 8;
+}
+
+message PBUiTransform {
+  YGPositionType position_type = 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;
+
+  YGOverflow overflow = 8;
+  YGDisplay display = 9;
+  YGDirection direction = 10;
+
+  float flex = 11;
+
+  YGUnit flex_basis_unit = 13;
+  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;
+}
+
+

package/ecs/components/common/Color3.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+message Color3 {
+    float r = 1;
+    float g = 2;
+    float b = 3;
+}
+  

package/ecs/components/common/Vector3.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+message Vector3 {
+    float x = 1;
+    float y = 2;
+    float z = 3;
+}

package/ecs/components/common/id.md

@@ -0,0 +1,2 @@
+# Why id as file option?
+Extending this option in the component definition allows having the data of its ID in the protocol buffer code generator. 

package/ecs/components/common/id.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FileOptions {
+  optional int32 ecs_component_id = 50000;
+}

package/kernel/apis/CommunicationsController.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+message RealSendRequest {
+    string message = 1;
+}
+
+message RealSendResponse {}
+
+service CommunicationsControllerService {
+    rpc Send(RealSendRequest) returns (RealSendResponse) {}
+}

package/kernel/apis/DevTools.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+message DevToolsBody {
+    string type = 1;
+    string json_payload = 2;
+}
+
+message EventResponse {}
+
+service DevToolsService {
+    rpc Event(DevToolsBody) returns (EventResponse) {}
+}