OpenTTD
network_type.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef NETWORK_TYPE_H
11 #define NETWORK_TYPE_H
12 
13 #include "core/game.h"
14 
16 static const uint MAX_CLIENTS = 255;
17 
23 static const uint MAX_CLIENT_SLOTS = 256;
24 
29  NETWORK_VEH_TRAIN = 0,
30  NETWORK_VEH_LORRY,
31  NETWORK_VEH_BUS,
32  NETWORK_VEH_PLANE,
33  NETWORK_VEH_SHIP,
34 
35  NETWORK_VEH_END
36 };
37 
39 enum ClientID : uint32 {
43 };
44 
46 typedef uint8 ClientIndex;
47 
49 typedef uint8 AdminIndex;
50 
52 static const AdminIndex MAX_ADMINS = 16;
54 static const AdminIndex INVALID_ADMIN_ID = UINT8_MAX;
55 
58  uint16 num_vehicle[NETWORK_VEH_END];
59  uint16 num_station[NETWORK_VEH_END];
60  bool ai;
61 };
62 
65  char password[NETWORK_PASSWORD_LENGTH];
66  uint16 months_empty;
67 };
68 
69 struct NetworkClientInfo;
70 
75 };
76 
78 enum DestType {
82 };
83 
86  NETWORK_ACTION_JOIN,
87  NETWORK_ACTION_LEAVE,
88  NETWORK_ACTION_SERVER_MESSAGE,
89  NETWORK_ACTION_CHAT,
90  NETWORK_ACTION_CHAT_COMPANY,
91  NETWORK_ACTION_CHAT_CLIENT,
92  NETWORK_ACTION_GIVE_MONEY,
93  NETWORK_ACTION_NAME_CHANGE,
94  NETWORK_ACTION_COMPANY_SPECTATOR,
95  NETWORK_ACTION_COMPANY_JOIN,
96  NETWORK_ACTION_COMPANY_NEW,
97 };
98 
101  NETWORK_ERROR_GENERAL, // Try to use this one like never
102 
103  /* Signals from clients */
104  NETWORK_ERROR_DESYNC,
105  NETWORK_ERROR_SAVEGAME_FAILED,
106  NETWORK_ERROR_CONNECTION_LOST,
107  NETWORK_ERROR_ILLEGAL_PACKET,
108  NETWORK_ERROR_NEWGRF_MISMATCH,
109 
110  /* Signals from servers */
111  NETWORK_ERROR_NOT_AUTHORIZED,
112  NETWORK_ERROR_NOT_EXPECTED,
113  NETWORK_ERROR_WRONG_REVISION,
114  NETWORK_ERROR_NAME_IN_USE,
115  NETWORK_ERROR_WRONG_PASSWORD,
116  NETWORK_ERROR_COMPANY_MISMATCH, // Happens in CLIENT_COMMAND
117  NETWORK_ERROR_KICKED,
118  NETWORK_ERROR_CHEATER,
119  NETWORK_ERROR_FULL,
120  NETWORK_ERROR_TOO_MANY_COMMANDS,
121  NETWORK_ERROR_TIMEOUT_PASSWORD,
122  NETWORK_ERROR_TIMEOUT_COMPUTER,
123  NETWORK_ERROR_TIMEOUT_MAP,
124  NETWORK_ERROR_TIMEOUT_JOIN,
125 
126  NETWORK_ERROR_END,
127 };
128 
129 #endif /* NETWORK_TYPE_H */
Send message/notice to all clients (All)
Definition: network_type.h:79
Container for all information known about a client.
Definition: network_base.h:23
bool ai
Is this company an AI.
Definition: network_type.h:60
NetworkErrorCode
The error codes we send around in the protocols.
Definition: network_type.h:100
static const uint MAX_CLIENTS
How many clients can we have.
Definition: network_type.h:16
static const AdminIndex INVALID_ADMIN_ID
An invalid admin marker.
Definition: network_type.h:54
Send message/notice to only a certain client (Private)
Definition: network_type.h:81
ClientID
&#39;Unique&#39; identifier to be given to clients
Definition: network_type.h:39
The first client ID.
Definition: network_type.h:42
Information about a game that is sent between a game server, game client and masterserver.
The password of the company.
Definition: network_type.h:74
uint16 months_empty
How many months the company is empty.
Definition: network_type.h:66
uint16 num_vehicle[NETWORK_VEH_END]
How many vehicles are there of this type?
Definition: network_type.h:58
static const AdminIndex MAX_ADMINS
Maximum number of allowed admins.
Definition: network_type.h:52
uint8 AdminIndex
Indices into the admin tables.
Definition: network_type.h:49
The password of the game.
Definition: network_type.h:73
NetworkVehicleType
Vehicletypes in the order they are send in info packets.
Definition: network_type.h:28
uint16 num_station[NETWORK_VEH_END]
How many stations are there of this type?
Definition: network_type.h:59
uint8 ClientIndex
Indices into the client tables.
Definition: network_type.h:46
static const uint MAX_CLIENT_SLOTS
The number of slots; must be at least 1 more than MAX_CLIENTS.
Definition: network_type.h:23
Client is not part of anything.
Definition: network_type.h:40
Simple calculated statistics of a company.
Definition: network_type.h:57
static const uint NETWORK_PASSWORD_LENGTH
The maximum length of the password, in bytes including &#39;\0&#39; (must be >= NETWORK_SERVER_ID_LENGTH) ...
Definition: config.h:45
Servers always have this ID.
Definition: network_type.h:41
Some state information of a company, especially for servers.
Definition: network_type.h:64
NetworkPasswordType
The type of password we&#39;re asking for.
Definition: network_type.h:72
Send message/notice to everyone playing the same company (Team)
Definition: network_type.h:80
DestType
Destination of our chat messages.
Definition: network_type.h:78
NetworkAction
Actions that can be used for NetworkTextMessage.
Definition: network_type.h:85