Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: added realminfo documentation #244

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: added realminfo documentation #244

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions proto/decentraland/sdk/components/realm_info.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
string realm_name = 2; // the name of the realm server
string realm_name = 2; // the name of the realm server (more info https://adr.decentraland.org/adr/ADR-110)

int32 network_id = 3; // the Ethereum network
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
int32 network_id = 3; // the Ethereum network
int32 network_id = 3; // the network id (1=Ethereum, more info https://chainlist.org/)

string comms_adapter = 4; // comms adapter, removing all query parameters (credentials)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
string comms_adapter = 4; // comms adapter, removing all query parameters (credentials)
string comms_adapter = 4; // comms adapter (more info https://adr.decentraland.org/adr/ADR-180)

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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking of changing this to
optional string room = 6; // (internal use) the room session id.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think can be useful for Scene Developer to know if the clients are in the same room and they see each other

optional bool is_connected_scene_room = 7; // true if the user is connected to the scene room.
}
Loading