1

/* $Id$ */

     2

     3

/** @file network_internal.h Variables and function used internally. */

     4

     5

#ifndef NETWORK_INTERNAL_H

     6

#define NETWORK_INTERNAL_H

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "../player_type.h"

    11

#include "../economy_type.h"

    12

#include "core/config.h"

    13

#include "core/game.h"

    14

    15

/**

    16

 * If this line is enable, every frame will have a sync test

    17

 *  this is not needed in normal games. Normal is like 1 sync in 100

    18

 *  frames. You can enable this if you have a lot of desyncs on a certain

    19

 *  game.

    20

 * Remember: both client and server have to be compiled with this

    21

 *  option enabled to make it to work. If one of the two has it disabled

    22

 *  nothing will happen.

    23

 */

    24

//#define ENABLE_NETWORK_SYNC_EVERY_FRAME

    25

    26

/**

    27

 * In theory sending 1 of the 2 seeds is enough to check for desyncs

    28

 *   so in theory, this next define can be left off.

    29

 */

    30

//#define NETWORK_SEND_DOUBLE_SEED

    31

    32

    33

enum {

    34

	/**

    35

	 * How many clients can we have? Like.. MAX_PLAYERS - 1 is the amount of

    36

	 *  players that can really play.. so.. a max of 4 spectators.. gives us..

    37

	 *  MAX_PLAYERS + 3

    38

	 */

    39

	MAX_CLIENTS = MAX_PLAYERS + 3,

    40

    41

	/** Do not change this next line. It should _ALWAYS_ be MAX_CLIENTS + 1 */

    42

	MAX_CLIENT_INFO = MAX_CLIENTS + 1,

    43

    44

	/** Maximum number of internet interfaces supported. */

    45

	MAX_INTERFACES = 9,

    46

    47

	/** How many vehicle/station types we put over the network */

    48

	NETWORK_VEHICLE_TYPES = 5,

    49

	NETWORK_STATION_TYPES = 5,

    50

};

    51

    52

struct NetworkPlayerInfo {

    53

	char company_name[NETWORK_NAME_LENGTH];         ///< Company name

    54

	char password[NETWORK_PASSWORD_LENGTH];         ///< The password for the player

    55

	Year inaugurated_year;                          ///< What year the company started in

    56

	Money company_value;                            ///< The company value

    57

	Money money;                                    ///< The amount of money the company has

    58

	Money income;                                   ///< How much did the company earned last year

    59

	uint16 performance;                             ///< What was his performance last month?

    60

	bool use_password;                              ///< Is there a password

    61

	uint16 num_vehicle[NETWORK_VEHICLE_TYPES];      ///< How many vehicles are there of this type?

    62

	uint16 num_station[NETWORK_STATION_TYPES];      ///< How many stations are there of this type?

    63

	char players[NETWORK_PLAYERS_LENGTH];           ///< The players that control this company (Name1, name2, ..)

    64

	uint16 months_empty;                            ///< How many months the company is empty

    65

};

    66

    67

struct NetworkClientInfo {

    68

	uint16 client_index;                            ///< Index of the client (same as ClientState->index)

    69

	char client_name[NETWORK_CLIENT_NAME_LENGTH];   ///< Name of the client

    70

	byte client_lang;                               ///< The language of the client

    71

	PlayerID client_playas;                         ///< As which player is this client playing (PlayerID)

    72

	uint32 client_ip;                               ///< IP-address of the client (so he can be banned)

    73

	Date join_date;                                 ///< Gamedate the player has joined

    74

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];       ///< Every play sends an unique id so we can indentify him

    75

};

    76

    77

enum NetworkJoinStatus {

    78

	NETWORK_JOIN_STATUS_CONNECTING,

    79

	NETWORK_JOIN_STATUS_AUTHORIZING,

    80

	NETWORK_JOIN_STATUS_WAITING,

    81

	NETWORK_JOIN_STATUS_DOWNLOADING,

    82

	NETWORK_JOIN_STATUS_PROCESSING,

    83

	NETWORK_JOIN_STATUS_REGISTERING,

    84

    85

	NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,

    86

};

    87

    88

/** Language ids for server_lang and client_lang. Do NOT modify the order. */

    89

enum NetworkLanguage {

    90

	NETLANG_ANY = 0,

    91

	NETLANG_ENGLISH,

    92

	NETLANG_GERMAN,

    93

	NETLANG_FRENCH,

    94

	NETLANG_BRAZILIAN,

    95

	NETLANG_BULGARIAN,

    96

	NETLANG_CHINESE,

    97

	NETLANG_CZECH,

    98

	NETLANG_DANISH,

    99

	NETLANG_DUTCH,

   100

	NETLANG_ESPERANTO,

   101

	NETLANG_FINNISH,

   102

	NETLANG_HUNGARIAN,

   103

	NETLANG_ICELANDIC,

   104

	NETLANG_ITALIAN,

   105

	NETLANG_JAPANESE,

   106

	NETLANG_KOREAN,

   107

	NETLANG_LITHUANIAN,

   108

	NETLANG_NORWEGIAN,

   109

	NETLANG_POLISH,

   110

	NETLANG_PORTUGUESE,

   111

	NETLANG_ROMANIAN,

   112

	NETLANG_RUSSIAN,

   113

	NETLANG_SLOVAK,

   114

	NETLANG_SLOVENIAN,

   115

	NETLANG_SPANISH,

   116

	NETLANG_SWEDISH,

   117

	NETLANG_TURKISH,

   118

	NETLANG_UKRAINIAN,

   119

	NETLANG_AFRIKAANS,

   120

	NETLANG_CROATIAN,

   121

	NETLANG_CATALAN,

   122

	NETLANG_ESTONIAN,

   123

	NETLANG_GALICIAN,

   124

	NETLANG_GREEK,

   125

	NETLANG_LATVIAN,

   126

	NETLANG_COUNT

   127

};

   128

   129

VARDEF NetworkGameInfo _network_game_info;

   130

VARDEF NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

   131

VARDEF NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

   132

   133

VARDEF char _network_player_name[NETWORK_CLIENT_NAME_LENGTH];

   134

VARDEF char _network_default_ip[NETWORK_HOSTNAME_LENGTH];

   135

   136

VARDEF uint16 _network_own_client_index;

   137

VARDEF char _network_unique_id[NETWORK_UNIQUE_ID_LENGTH]; // Our own unique ID

   138

   139

VARDEF uint32 _frame_counter_server; // The frame_counter of the server, if in network-mode

   140

VARDEF uint32 _frame_counter_max; // To where we may go with our clients

   141

   142

VARDEF uint32 _last_sync_frame; // Used in the server to store the last time a sync packet was sent to clients.

   143

   144

// networking settings

   145

VARDEF uint32 _broadcast_list[MAX_INTERFACES + 1];

   146

   147

VARDEF uint16 _network_server_port;

   148

/* We use bind_ip and bind_ip_host, where bind_ip_host is the readable form of

   149

    bind_ip_host, and bind_ip the numeric value, because we want a nice number

   150

    in the openttd.cfg, but we wants to use the uint32 internally.. */

   151

VARDEF uint32 _network_server_bind_ip;

   152

VARDEF char _network_server_bind_ip_host[NETWORK_HOSTNAME_LENGTH];

   153

VARDEF bool _is_network_server; // Does this client wants to be a network-server?

   154

VARDEF char _network_server_name[NETWORK_NAME_LENGTH];

   155

VARDEF char _network_server_password[NETWORK_PASSWORD_LENGTH];

   156

VARDEF char _network_rcon_password[NETWORK_PASSWORD_LENGTH];

   157

VARDEF char _network_default_company_pass[NETWORK_PASSWORD_LENGTH];

   158

   159

VARDEF uint16 _network_max_join_time;             ///< Time a client can max take to join

   160

VARDEF bool _network_pause_on_join;               ///< Pause the game when a client tries to join (more chance of succeeding join)

   161

   162

VARDEF uint16 _redirect_console_to_client;

   163

   164

VARDEF uint16 _network_sync_freq;

   165

VARDEF uint8 _network_frame_freq;

   166

   167

VARDEF uint32 _sync_seed_1, _sync_seed_2;

   168

VARDEF uint32 _sync_frame;

   169

VARDEF bool _network_first_time;

   170

// Vars needed for the join-GUI

   171

VARDEF NetworkJoinStatus _network_join_status;

   172

VARDEF uint8 _network_join_waiting;

   173

VARDEF uint16 _network_join_kbytes;

   174

VARDEF uint16 _network_join_kbytes_total;

   175

   176

VARDEF char _network_last_host[NETWORK_HOSTNAME_LENGTH];

   177

VARDEF short _network_last_port;

   178

VARDEF uint32 _network_last_host_ip;

   179

VARDEF uint8 _network_reconnect;

   180

   181

VARDEF bool _network_udp_server;

   182

VARDEF uint16 _network_udp_broadcast;

   183

   184

VARDEF byte _network_lan_internet;

   185

   186

VARDEF bool _network_need_advertise;

   187

VARDEF uint32 _network_last_advertise_frame;

   188

VARDEF uint8 _network_advertise_retries;

   189

   190

VARDEF bool _network_autoclean_companies;

   191

VARDEF uint8 _network_autoclean_unprotected; // Remove a company after X months

   192

VARDEF uint8 _network_autoclean_protected;   // Unprotect a company after X months

   193

   194

VARDEF Year _network_restart_game_year;      // If this year is reached, the server automaticly restarts

   195

VARDEF uint8 _network_min_players;           // Minimum number of players for game to unpause

   196

   197

void NetworkTCPQueryServer(const char* host, unsigned short port);

   198

   199

byte NetworkSpectatorCount();

   200

   201

VARDEF char *_network_host_list[10];

   202

VARDEF char *_network_ban_list[25];

   203

   204

void ParseConnectionString(const char **player, const char **port, char *connection_string);

   205

void NetworkUpdateClientInfo(uint16 client_index);

   206

void NetworkAddServer(const char *b);

   207

void NetworkRebuildHostList();

   208

bool NetworkChangeCompanyPassword(byte argc, char *argv[]);

   209

void NetworkPopulateCompanyInfo();

   210

void UpdateNetworkGameWindow(bool unselect);

   211

void CheckMinPlayers();

   212

void NetworkStartDebugLog(const char *hostname, uint16 port);

   213

   214

void NetworkUDPCloseAll();

   215

void NetworkGameLoop();

   216

void NetworkUDPGameLoop();

   217

bool NetworkServerStart();

   218

bool NetworkClientConnectGame(const char *host, uint16 port);

   219

void NetworkReboot();

   220

void NetworkDisconnect();

   221

   222

bool IsNetworkCompatibleVersion(const char *version);

   223

   224

#endif /* ENABLE_NETWORK */

   225

#endif /* NETWORK_INTERNAL_H */