mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-07-14 14:32:15 -07:00
clean up comments
This commit is contained in:
parent
ccca83a699
commit
f276e33e5e
5 changed files with 12 additions and 10 deletions
|
|
@ -2,14 +2,15 @@ syntax = "proto2";
|
||||||
import "game_event.proto";
|
import "game_event.proto";
|
||||||
import "serverinfo_player.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
|
// Signals that the game state has changed.
|
||||||
// state, also used to provide the entire game state when joining a game
|
// 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 {
|
message Event_GameStateChanged {
|
||||||
extend GameEvent {
|
extend GameEvent {
|
||||||
optional Event_GameStateChanged ext = 1005;
|
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;
|
repeated ServerInfo_Player player_list = 1;
|
||||||
|
|
||||||
// if the game has started
|
// if the game has started
|
||||||
|
|
|
||||||
|
|
@ -19,8 +19,9 @@ message Event_MoveCard {
|
||||||
// The original zone
|
// The original zone
|
||||||
optional string start_zone = 4;
|
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
|
// The original position that the card was at.
|
||||||
// without y coordinate, in zones with a y coordinate this value is not used
|
// 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];
|
optional sint32 position = 5 [default = -1];
|
||||||
|
|
||||||
// The player who owns the new zone the card is in
|
// 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
|
// If the card is face down, face down cards will not show their name
|
||||||
optional bool face_down = 11;
|
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
|
// The provider id of the card in case it was not known yet.
|
||||||
// type of card
|
// Extends the name to supply a specific printing of that type of card.
|
||||||
optional string new_card_provider_id = 12;
|
optional string new_card_provider_id = 12;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ message Command_CreateGame {
|
||||||
// game description shown in game list
|
// game description shown in game list
|
||||||
optional string description = 1;
|
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;
|
optional string password = 2;
|
||||||
|
|
||||||
// amount of players needed to play
|
// amount of players needed to play
|
||||||
|
|
|
||||||
|
|
@ -51,6 +51,6 @@ message ServerInfo_Card {
|
||||||
// the unique id of the card in that zone
|
// the unique id of the card in that zone
|
||||||
optional sint32 attach_card_id = 16 [default = -1];
|
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;
|
optional string provider_id = 17;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -60,6 +60,6 @@ message ServerInfo_Game {
|
||||||
// time that the game started at
|
// time that the game started at
|
||||||
optional uint32 start_time = 51;
|
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;
|
optional bool closed = 52;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue