From f276e33e5eccc39620b612ba796c8caa78770113 Mon Sep 17 00:00:00 2001 From: RickyRister Date: Sun, 21 Sep 2025 15:45:46 -0700 Subject: [PATCH] clean up comments --- common/pb/event_game_state_changed.proto | 7 ++++--- common/pb/event_move_card.proto | 9 +++++---- common/pb/room_commands.proto | 2 +- common/pb/serverinfo_card.proto | 2 +- common/pb/serverinfo_game.proto | 2 +- 5 files changed, 12 insertions(+), 10 deletions(-) diff --git a/common/pb/event_game_state_changed.proto b/common/pb/event_game_state_changed.proto index 931068e4f..5c8aee3fe 100644 --- a/common/pb/event_game_state_changed.proto +++ b/common/pb/event_game_state_changed.proto @@ -2,14 +2,15 @@ syntax = "proto2"; import "game_event.proto"; import "serverinfo_player.proto"; -// Signals that the game state has changed, if a field is present in this message it will overwrite the client's game -// state, also used to provide the entire game state when joining a game +// Signals that the game state has changed. +// If a field is present in this message, it will overwrite the client's game state. +// Also used to provide the entire game state when joining a game. message Event_GameStateChanged { extend GameEvent { optional Event_GameStateChanged ext = 1005; } - // the list of players, players contain their zones which contain all cards in the game + // the list of players. Players contain their zones which contain all cards in the game repeated ServerInfo_Player player_list = 1; // if the game has started diff --git a/common/pb/event_move_card.proto b/common/pb/event_move_card.proto index 9a1121bf8..e8e60066a 100644 --- a/common/pb/event_move_card.proto +++ b/common/pb/event_move_card.proto @@ -19,8 +19,9 @@ message Event_MoveCard { // The original zone optional string start_zone = 4; - // The original position that the card was at, this corresponds with the previous x coordinate of the card in zones - // without y coordinate, in zones with a y coordinate this value is not used + // The original position that the card was at. + // In zones without y coordinate, this corresponds with the previous x coordinate of the card. + // In zones with y coordinate, this value is not used. optional sint32 position = 5 [default = -1]; // The player who owns the new zone the card is in @@ -41,7 +42,7 @@ message Event_MoveCard { // If the card is face down, face down cards will not show their name optional bool face_down = 11; - // The provider id of the card in case it was not known yet, extends the name to supply a specific version of that - // type of card + // The provider id of the card in case it was not known yet. + // Extends the name to supply a specific printing of that type of card. optional string new_card_provider_id = 12; } diff --git a/common/pb/room_commands.proto b/common/pb/room_commands.proto index 5557df69e..a8c90ec6c 100644 --- a/common/pb/room_commands.proto +++ b/common/pb/room_commands.proto @@ -31,7 +31,7 @@ message Command_CreateGame { // game description shown in game list optional string description = 1; - // password users will have to provide to joing the game + // password users will have to provide to join the game optional string password = 2; // amount of players needed to play diff --git a/common/pb/serverinfo_card.proto b/common/pb/serverinfo_card.proto index e68f8e249..a9a8b5c9d 100644 --- a/common/pb/serverinfo_card.proto +++ b/common/pb/serverinfo_card.proto @@ -51,6 +51,6 @@ message ServerInfo_Card { // the unique id of the card in that zone optional sint32 attach_card_id = 16 [default = -1]; - // unique id of this kind of card, extends the name to specify a specific version of a type of card + // unique id of this kind of card, extends the name to specify a specific printing of a card optional string provider_id = 17; } diff --git a/common/pb/serverinfo_game.proto b/common/pb/serverinfo_game.proto index 737473ce7..9a56e034c 100644 --- a/common/pb/serverinfo_game.proto +++ b/common/pb/serverinfo_game.proto @@ -60,6 +60,6 @@ message ServerInfo_Game { // time that the game started at optional uint32 start_time = 51; - // whether the game is closed, closed games are finished and can't be interacted with + // whether the game is closed. Closed games are finished and can't be interacted with optional bool closed = 52; }