OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

network_func.h
Go to the documentation of this file.
1 /* $Id: network_func.h 27400 2015-09-19 16:49:46Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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 <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef NETWORK_FUNC_H
13 #define NETWORK_FUNC_H
14
19 // #define DEBUG_DUMP_COMMANDS
20 // #define DEBUG_FAILED_DUMP_COMMANDS
21
22 #include "core/address.h"
23 #include "network_type.h"
24 #include "../console_type.h"
25 #include "../gfx_type.h"
26 #include "../openttd.h"
27 #include "../company_type.h"
28
29 #ifdef ENABLE_NETWORK
30
31 extern NetworkServerGameInfo _network_game_info;
32 extern NetworkCompanyState *_network_company_states;
33
34 extern ClientID _network_own_client_id;
35 extern ClientID _redirect_console_to_client;
36 extern bool _network_need_advertise;
37 extern uint8 _network_reconnect;
38 extern StringList _network_bind_list;
39 extern StringList _network_host_list;
40 extern StringList _network_ban_list;
41
42 byte NetworkSpectatorCount();
43 void NetworkUpdateClientName();
44 bool NetworkCompanyHasClients(CompanyID company);
45 const char *NetworkChangeCompanyPassword(CompanyID company_id, const char *password);
46 void NetworkReboot();
47 void NetworkDisconnect(bool blocking = false, bool close_admins = true);
48 void NetworkGameLoop();
49 void NetworkBackgroundLoop();
50 void ParseConnectionString(const char **company, const char **port, char *connection_string);
51 void NetworkStartDebugLog(NetworkAddress address);
52 void NetworkPopulateCompanyStats(NetworkCompanyStats *stats);
53
54 void NetworkUpdateClientInfo(ClientID client_id);
55 void NetworkClientsToSpectators(CompanyID cid);
56 void NetworkClientConnectGame(NetworkAddress address, CompanyID join_as, const char *join_server_password = NULL, const char *join_company_password = NULL);
57 void NetworkClientRequestMove(CompanyID company, const char *pass = "");
58 void NetworkClientSendRcon(const char *password, const char *command);
59 void NetworkClientSendChat(NetworkAction action, DestType type, int dest, const char *msg, int64 data = 0);
60 bool NetworkClientPreferTeamChat(const NetworkClientInfo *cio);
61 bool NetworkCompanyIsPassworded(CompanyID company_id);
62 bool NetworkMaxCompaniesReached();
63 bool NetworkMaxSpectatorsReached();
64 void NetworkPrintClients();
65 void NetworkHandlePauseChange(PauseMode prev_mode, PauseMode changed_mode);
66
67 /*** Commands ran by the server ***/
68 void NetworkServerDailyLoop();
69 void NetworkServerMonthlyLoop();
70 void NetworkServerYearlyLoop();
71 void NetworkServerSendConfigUpdate();
72 void NetworkServerShowStatusToConsole();
73 bool NetworkServerStart();
74 void NetworkServerNewCompany(const Company *company, NetworkClientInfo *ci);
75 bool NetworkServerChangeClientName(ClientID client_id, const char *new_name);
76
77
78 void NetworkServerDoMove(ClientID client_id, CompanyID company_id);
79 void NetworkServerSendRcon(ClientID client_id, TextColour colour_code, const char *string);
80 void NetworkServerSendChat(NetworkAction action, DestType type, int dest, const char *msg, ClientID from_id, int64 data = 0, bool from_admin = false);
81
82 void NetworkServerKickClient(ClientID client_id);
83 uint NetworkServerKickOrBanIP(ClientID client_id, bool ban);
84 uint NetworkServerKickOrBanIP(const char *ip, bool ban);
85
86 void NetworkInitChatMessage();
87 void CDECL NetworkAddChatMessage(TextColour colour, uint duration, const char *message, ...) WARN_FORMAT(3, 4);
88 void NetworkUndrawChatMessage();
89 void NetworkChatMessageLoop();
90
91 void NetworkAfterNewGRFScan();
92
93 #endif /* ENABLE_NETWORK */
94 #endif /* NETWORK_FUNC_H */