OpenTTD Source: src/network/core/tcp_content_type.h Source File

OpenTTD Source 13.1

tcp_content_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
12 #ifndef NETWORK_CORE_TCP_CONTENT_TYPE_H
13 #define NETWORK_CORE_TCP_CONTENT_TYPE_H
14
16 enum ContentType {
17 CONTENT_TYPE_BEGIN = 1,
18 CONTENT_TYPE_BASE_GRAPHICS = 1,
19 CONTENT_TYPE_NEWGRF = 2,
20 CONTENT_TYPE_AI = 3,
21 CONTENT_TYPE_AI_LIBRARY = 4,
22 CONTENT_TYPE_SCENARIO = 5,
23 CONTENT_TYPE_HEIGHTMAP = 6,
24 CONTENT_TYPE_BASE_SOUNDS = 7,
25 CONTENT_TYPE_BASE_MUSIC = 8,
26 CONTENT_TYPE_GAME = 9,
27 CONTENT_TYPE_GAME_LIBRARY = 10,
28 CONTENT_TYPE_END,
29 INVALID_CONTENT_TYPE = 0xFF,
30 };
31
33 enum PacketContentType {
34 PACKET_CONTENT_CLIENT_INFO_LIST,
35 PACKET_CONTENT_CLIENT_INFO_ID,
36 PACKET_CONTENT_CLIENT_INFO_EXTID,
37 PACKET_CONTENT_CLIENT_INFO_EXTID_MD5,
38 PACKET_CONTENT_SERVER_INFO,
39 PACKET_CONTENT_CLIENT_CONTENT,
40 PACKET_CONTENT_SERVER_CONTENT,
41 PACKET_CONTENT_END,
42 };
43
45 enum ContentID {
46 INVALID_CONTENT_ID = UINT32_MAX,
47 };
48
50 struct ContentInfo {
52 enum State {
53 UNSELECTED,
54 SELECTED,
55 AUTOSELECTED,
56 ALREADY_HERE,
57 DOES_NOT_EXIST,
58 INVALID,
59 };
60
61 ContentType type = INVALID_CONTENT_TYPE;
62 ContentID id = INVALID_CONTENT_ID;
63 uint32 filesize = 0;
64 std::string filename;
65 std::string name;
66 std::string version;
67 std::string url;
68 std::string description;
69 uint32 unique_id = 0;
70 byte md5sum[16] = {0};
71 std::vector<ContentID> dependencies;
72 StringList tags;
73 State state = State::UNSELECTED;
74 bool upgrade = false;
75
76 bool IsSelected() const;
77 bool IsValid() const;
78 const char *GetTextfile(TextfileType type) const;
79 };
80
81 #endif /* NETWORK_CORE_TCP_CONTENT_TYPE_H */
ContentInfo::IsSelected
bool IsSelected() const
Is the state either selected or autoselected?
Definition: tcp_content.cpp:27
ContentInfo::name
std::string name
Name of the content.
Definition: tcp_content_type.h:65
ContentInfo::GetTextfile
const char * GetTextfile(TextfileType type) const
Search a textfile file next to this file in the content list.
Definition: tcp_content.cpp:54
ContentInfo::type
ContentType type
Type of content.
Definition: tcp_content_type.h:61
CONTENT_TYPE_GAME_LIBRARY
@ CONTENT_TYPE_GAME_LIBRARY
The content consists of a GS library.
Definition: tcp_content_type.h:27
ContentInfo::upgrade
bool upgrade
This item is an upgrade.
Definition: tcp_content_type.h:74
ContentInfo::DOES_NOT_EXIST
@ DOES_NOT_EXIST
The content does not exist in the content system.
Definition: tcp_content_type.h:57
CONTENT_TYPE_NEWGRF
@ CONTENT_TYPE_NEWGRF
The content consists of a NewGRF.
Definition: tcp_content_type.h:19
ContentInfo::url
std::string url
URL related to the content.
Definition: tcp_content_type.h:67
PACKET_CONTENT_SERVER_CONTENT
@ PACKET_CONTENT_SERVER_CONTENT
Reply with the content of the given ID.
Definition: tcp_content_type.h:40
ContentInfo::State
State
The state the content can be in.
Definition: tcp_content_type.h:52
INVALID_CONTENT_ID
@ INVALID_CONTENT_ID
Sentinel for invalid content.
Definition: tcp_content_type.h:46
CONTENT_TYPE_END
@ CONTENT_TYPE_END
Helper to mark the end of the types.
Definition: tcp_content_type.h:28
ContentInfo::version
std::string version
Version of the content.
Definition: tcp_content_type.h:66
PACKET_CONTENT_CLIENT_INFO_EXTID_MD5
@ PACKET_CONTENT_CLIENT_INFO_EXTID_MD5
Queries the content server for information about a list of external IDs and MD5.
Definition: tcp_content_type.h:37
ContentInfo::IsValid
bool IsValid() const
Is the information from this content info valid?
Definition: tcp_content.cpp:44
ContentType
ContentType
The values in the enum are important; they are used as database 'keys'.
Definition: tcp_content_type.h:16
PacketContentType
PacketContentType
Enum with all types of TCP content packets.
Definition: tcp_content_type.h:33
PACKET_CONTENT_END
@ PACKET_CONTENT_END
Must ALWAYS be on the end of this list!! (period)
Definition: tcp_content_type.h:41
CONTENT_TYPE_GAME
@ CONTENT_TYPE_GAME
The content consists of a game script.
Definition: tcp_content_type.h:26
ContentInfo::UNSELECTED
@ UNSELECTED
The content has not been selected.
Definition: tcp_content_type.h:53
PACKET_CONTENT_CLIENT_INFO_ID
@ PACKET_CONTENT_CLIENT_INFO_ID
Queries the content server for information about a list of internal IDs.
Definition: tcp_content_type.h:35
ContentInfo
Container for all important information about a piece of content.
Definition: tcp_content_type.h:50
ContentInfo::md5sum
byte md5sum[16]
The MD5 checksum.
Definition: tcp_content_type.h:70
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:59
ContentInfo::SELECTED
@ SELECTED
The content has been manually selected.
Definition: tcp_content_type.h:54
PACKET_CONTENT_CLIENT_CONTENT
@ PACKET_CONTENT_CLIENT_CONTENT
Request a content file given an internal ID.
Definition: tcp_content_type.h:39
ContentInfo::tags
StringList tags
Tags associated with the content.
Definition: tcp_content_type.h:72
ContentInfo::dependencies
std::vector< ContentID > dependencies
The dependencies (unique server side ids)
Definition: tcp_content_type.h:71
PACKET_CONTENT_CLIENT_INFO_EXTID
@ PACKET_CONTENT_CLIENT_INFO_EXTID
Queries the content server for information about a list of external IDs.
Definition: tcp_content_type.h:36
INVALID_CONTENT_TYPE
@ INVALID_CONTENT_TYPE
Invalid/uninitialized content.
Definition: tcp_content_type.h:29
CONTENT_TYPE_AI
@ CONTENT_TYPE_AI
The content consists of an AI.
Definition: tcp_content_type.h:20
CONTENT_TYPE_BASE_GRAPHICS
@ CONTENT_TYPE_BASE_GRAPHICS
The content consists of base graphics.
Definition: tcp_content_type.h:18
ContentInfo::ALREADY_HERE
@ ALREADY_HERE
The content is already at the client side.
Definition: tcp_content_type.h:56
ContentInfo::AUTOSELECTED
@ AUTOSELECTED
The content has been selected as dependency.
Definition: tcp_content_type.h:55
CONTENT_TYPE_AI_LIBRARY
@ CONTENT_TYPE_AI_LIBRARY
The content consists of an AI library.
Definition: tcp_content_type.h:21
ContentID
ContentID
Unique identifier for the content.
Definition: tcp_content_type.h:45
ContentInfo::filename
std::string filename
Filename (for the .tar.gz; only valid on download)
Definition: tcp_content_type.h:64
CONTENT_TYPE_BEGIN
@ CONTENT_TYPE_BEGIN
Helper to mark the begin of the types.
Definition: tcp_content_type.h:17
PACKET_CONTENT_SERVER_INFO
@ PACKET_CONTENT_SERVER_INFO
Reply of content server with information about content.
Definition: tcp_content_type.h:38
ContentInfo::state
State state
Whether the content info is selected (for download)
Definition: tcp_content_type.h:73
CONTENT_TYPE_BASE_SOUNDS
@ CONTENT_TYPE_BASE_SOUNDS
The content consists of base sounds.
Definition: tcp_content_type.h:24
ContentInfo::unique_id
uint32 unique_id
Unique ID; either GRF ID or shortname.
Definition: tcp_content_type.h:69
PACKET_CONTENT_CLIENT_INFO_LIST
@ PACKET_CONTENT_CLIENT_INFO_LIST
Queries the content server for a list of info of a given content type.
Definition: tcp_content_type.h:34
CONTENT_TYPE_SCENARIO
@ CONTENT_TYPE_SCENARIO
The content consists of a scenario.
Definition: tcp_content_type.h:22
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
ContentInfo::INVALID
@ INVALID
The content's invalid.
Definition: tcp_content_type.h:58
ContentInfo::description
std::string description
Description of the content.
Definition: tcp_content_type.h:68
CONTENT_TYPE_HEIGHTMAP
@ CONTENT_TYPE_HEIGHTMAP
The content consists of a heightmap.
Definition: tcp_content_type.h:23
ContentInfo::filesize
uint32 filesize
Size of the file.
Definition: tcp_content_type.h:63
CONTENT_TYPE_BASE_MUSIC
@ CONTENT_TYPE_BASE_MUSIC
The content consists of base music.
Definition: tcp_content_type.h:25