network_game_info.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */
 
#ifndef NETWORK_CORE_GAME_INFO_H
#define NETWORK_CORE_GAME_INFO_H
 
#include "config.h"
#include "core.h"
#include "../../newgrf_config.h"
#include "../../timer/timer_game_calendar.h"
#include "../../timer/timer_game_tick.h"
#include "../../landscape_type.h"
 
#include <unordered_map>
 
enum NewGRFSerializationType {
  NST_GRFID_MD5      = 0, 
  NST_GRFID_MD5_NAME = 1, 
  NST_LOOKUP_ID      = 2, 
  NST_END                 
};
 
struct NetworkServerGameInfo {
  GRFConfigList grfconfig; 
  TimerGameCalendar::Date calendar_start; 
  TimerGameCalendar::Date calendar_date; 
  TimerGameTick::TickCounter ticks_playing; 
  uint16_t map_width;            
  uint16_t map_height;           
  std::string server_name;     
  std::string server_revision; 
  bool dedicated;              
  bool use_password;           
  uint8_t clients_on;             
  uint8_t clients_max;            
  uint8_t companies_on;           
  uint8_t companies_max;          
  uint8_t spectators_on;          
  LandscapeType landscape;              
  int gamescript_version;      
  std::string gamescript_name; 
};
 
struct NetworkGameInfo : NetworkServerGameInfo {
  bool version_compatible;                        
  bool compatible;                                
};
 
struct NamedGRFIdentifier {
  GRFIdentifier ident; 
  std::string name;    
};
typedef std::unordered_map<uint32_t, NamedGRFIdentifier> GameInfoNewGRFLookupTable;
 
extern NetworkServerGameInfo _network_game_info;
 
std::string_view GetNetworkRevisionString();
bool IsNetworkCompatibleVersion(std::string_view other);
void CheckGameCompatibility(NetworkGameInfo &ngi);
 
void FillStaticNetworkServerGameInfo();
const NetworkServerGameInfo &GetCurrentNetworkServerGameInfo();
 
void DeserializeGRFIdentifier(Packet &p, GRFIdentifier &grf);
void DeserializeGRFIdentifierWithName(Packet &p, NamedGRFIdentifier &grf);
void SerializeGRFIdentifier(Packet &p, const GRFIdentifier &grf);
 
void DeserializeNetworkGameInfo(Packet &p, NetworkGameInfo &info, const GameInfoNewGRFLookupTable *newgrf_lookup_table = nullptr);
void SerializeNetworkGameInfo(Packet &p, const NetworkServerGameInfo &info, bool send_newgrf_names = true);
 
#endif /* NETWORK_CORE_GAME_INFO_H */