From f08003b281e46bc0d2b2697b0093ec8d0e88a7c2 Mon Sep 17 00:00:00 2001 From: Alejandro Alvarez Melucci Date: Tue, 4 Feb 2025 17:20:08 -0300 Subject: [PATCH] Added documentation to realm info protobuf definition --- proto/decentraland/sdk/components/realm_info.proto | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/proto/decentraland/sdk/components/realm_info.proto b/proto/decentraland/sdk/components/realm_info.proto index 6c6b7301..c75c69ad 100644 --- a/proto/decentraland/sdk/components/realm_info.proto +++ b/proto/decentraland/sdk/components/realm_info.proto @@ -5,11 +5,11 @@ import "decentraland/sdk/components/common/id.proto"; option (common.ecs_component_id) = 1106; message PBRealmInfo { - string base_url = 1; - string realm_name = 2; - int32 network_id = 3; - string comms_adapter = 4; - bool is_preview = 5; - optional string room = 6; - optional bool is_connected_scene_room = 7; + string base_url = 1; // the domain of the realm server + string realm_name = 2; // the name of the realm server + int32 network_id = 3; // the Ethereum network + string comms_adapter = 4; // comms adapter, removing all query parameters (credentials) + bool is_preview = 5; // true if the scene is running as a local preview, instead of published in Decentraland. + optional string room = 6; // the room session id. + optional bool is_connected_scene_room = 7; // true if the user is connected to the scene room. }