1

/* $Id$ */

     2

     3

#ifndef NETWORK_INTERNAL_H

     4

#define NETWORK_INTERNAL_H

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "../player_type.h"

     9

#include "../economy_type.h"

    10

#include "core/config.h"

    11

#include "core/game.h"

    12

    13

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

    14

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

    15

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

    16

//  game.

    17

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

    18

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

    19

//  nothing will happen.

    20

//#define ENABLE_NETWORK_SYNC_EVERY_FRAME

    21

    22

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

    23

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

    24

//#define NETWORK_SEND_DOUBLE_SEED

    25

    26

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

    27

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

    28

//  MAX_PLAYERS + 3

    29

#define MAX_CLIENTS (MAX_PLAYERS + 3)

    30

    31

    32

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

    33

#define MAX_CLIENT_INFO (MAX_CLIENTS + 1)

    34

    35

#define MAX_INTERFACES 9

    36

    37

    38

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

    39

#define NETWORK_VEHICLE_TYPES 5

    40

#define NETWORK_STATION_TYPES 5

    41

    42

struct NetworkPlayerInfo {

    43

	char company_name[NETWORK_NAME_LENGTH];         // Company name

    44

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

    45

	Year inaugurated_year;                          // What year the company started in

    46

	Money company_value;                            // The company value

    47

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

    48

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

    49

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

    50

	bool use_password;                              // Is there a password

    51

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

    52

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

    53

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

    54

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

    55

};

    56

    57

struct NetworkClientInfo {

    58

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

    59

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

    60

	byte client_lang;                               // The language of the client

    61

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

    62

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

    63

	Date join_date;                                 // Gamedate the player has joined

    64

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

    65

};

    66

    67

enum NetworkJoinStatus {

    68

	NETWORK_JOIN_STATUS_CONNECTING,

    69

	NETWORK_JOIN_STATUS_AUTHORIZING,

    70

	NETWORK_JOIN_STATUS_WAITING,

    71

	NETWORK_JOIN_STATUS_DOWNLOADING,

    72

	NETWORK_JOIN_STATUS_PROCESSING,

    73

	NETWORK_JOIN_STATUS_REGISTERING,

    74

    75

	NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,

    76

};

    77

    78

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

    79

enum NetworkLanguage {

    80

	NETLANG_ANY = 0,

    81

	NETLANG_ENGLISH,

    82

	NETLANG_GERMAN,

    83

	NETLANG_FRENCH,

    84

	NETLANG_BRAZILIAN,

    85

	NETLANG_BULGARIAN,

    86

	NETLANG_CHINESE,

    87

	NETLANG_CZECH,

    88

	NETLANG_DANISH,

    89

	NETLANG_DUTCH,

    90

	NETLANG_ESPERANTO,

    91

	NETLANG_FINNISH,

    92

	NETLANG_HUNGARIAN,

    93

	NETLANG_ICELANDIC,

    94

	NETLANG_ITALIAN,

    95

	NETLANG_JAPANESE,

    96

	NETLANG_KOREAN,

    97

	NETLANG_LITHUANIAN,

    98

	NETLANG_NORWEGIAN,

    99

	NETLANG_POLISH,

   100

	NETLANG_PORTUGUESE,

   101

	NETLANG_ROMANIAN,

   102

	NETLANG_RUSSIAN,

   103

	NETLANG_SLOVAK,

   104

	NETLANG_SLOVENIAN,

   105

	NETLANG_SPANISH,

   106

	NETLANG_SWEDISH,

   107

	NETLANG_TURKISH,

   108

	NETLANG_UKRAINIAN,

   116

	NETLANG_COUNT

   117

};

   118

   119

VARDEF NetworkGameInfo _network_game_info;

   120

VARDEF NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

   121

VARDEF NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

   122

   123

VARDEF char _network_player_name[NETWORK_CLIENT_NAME_LENGTH];

   124

VARDEF char _network_default_ip[NETWORK_HOSTNAME_LENGTH];

   125

   126

VARDEF uint16 _network_own_client_index;

   127

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

   128

   129

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

   130

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

   131

   132

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

   133

   134

// networking settings

   135

VARDEF uint32 _broadcast_list[MAX_INTERFACES + 1];

   136

   137

VARDEF uint16 _network_server_port;

   138

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

   139

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

   140

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

   141

VARDEF uint32 _network_server_bind_ip;

   142

VARDEF char _network_server_bind_ip_host[NETWORK_HOSTNAME_LENGTH];

   143

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

   144

VARDEF char _network_server_name[NETWORK_NAME_LENGTH];

   145

VARDEF char _network_server_password[NETWORK_PASSWORD_LENGTH];

   146

VARDEF char _network_rcon_password[NETWORK_PASSWORD_LENGTH];

   147

VARDEF char _network_default_company_pass[NETWORK_PASSWORD_LENGTH];

   148

   149

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

   150

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

   151

   152

VARDEF uint16 _redirect_console_to_client;

   153

   154

VARDEF uint16 _network_sync_freq;

   155

VARDEF uint8 _network_frame_freq;

   156

   157

VARDEF uint32 _sync_seed_1, _sync_seed_2;

   158

VARDEF uint32 _sync_frame;

   159

VARDEF bool _network_first_time;

   160

// Vars needed for the join-GUI

   161

VARDEF NetworkJoinStatus _network_join_status;

   162

VARDEF uint8 _network_join_waiting;

   163

VARDEF uint16 _network_join_kbytes;

   164

VARDEF uint16 _network_join_kbytes_total;

   165

   166

VARDEF char _network_last_host[NETWORK_HOSTNAME_LENGTH];

   167

VARDEF short _network_last_port;

   168

VARDEF uint32 _network_last_host_ip;

   169

VARDEF uint8 _network_reconnect;

   170

   171

VARDEF bool _network_udp_server;

   172

VARDEF uint16 _network_udp_broadcast;

   173

   174

VARDEF byte _network_lan_internet;

   175

   176

VARDEF bool _network_need_advertise;

   177

VARDEF uint32 _network_last_advertise_frame;

   178

VARDEF uint8 _network_advertise_retries;

   179

   180

VARDEF bool _network_autoclean_companies;

   181

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

   182

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

   183

   184

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

   185

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

   186

   187

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

   188

   189

byte NetworkSpectatorCount();

   190

   191

VARDEF char *_network_host_list[10];

   192

VARDEF char *_network_ban_list[25];

   193

   194

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

   195

void NetworkUpdateClientInfo(uint16 client_index);

   196

void NetworkAddServer(const char *b);

   197

void NetworkRebuildHostList();

   198

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

   199

void NetworkPopulateCompanyInfo();

   200

void UpdateNetworkGameWindow(bool unselect);

   201

void CheckMinPlayers();

   202

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

   203

   204

void NetworkUDPCloseAll();

   205

void NetworkGameLoop();

   206

void NetworkUDPGameLoop();

   207

bool NetworkServerStart();

   208

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

   209

void NetworkReboot();

   210

void NetworkDisconnect();

   211

   212

bool IsNetworkCompatibleVersion(const char *version);

   213

   214

#endif /* ENABLE_NETWORK */

   215

#endif /* NETWORK_INTERNAL_H */