OpenTTD Source: src/newgrf_config.h Source File

OpenTTD Source 15.0-beta1

newgrf_config.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 NEWGRF_CONFIG_H
11#define NEWGRF_CONFIG_H
12
13#include "strings_type.h"
14#include "core/alloc_type.hpp"
15#include "fileio_type.h"
16#include "textfile_type.h"
17#include "newgrf_text.h"
18#include "3rdparty/md5/md5.h"
19
21 enum GCF_Flags {
22 GCF_SYSTEM,
23 GCF_UNSAFE,
24 GCF_STATIC,
25 GCF_COMPATIBLE,
26 GCF_COPY,
27 GCF_INIT_ONLY,
28 GCF_RESERVED,
29 GCF_INVALID,
30};
31
33 enum GRFStatus {
34 GCS_UNKNOWN,
35 GCS_DISABLED,
36 GCS_NOT_FOUND,
37 GCS_INITIALISED,
38 GCS_ACTIVATED,
39};
40
42 enum GRFBugs {
43 GBUG_VEH_LENGTH,
44 GBUG_VEH_REFIT,
45 GBUG_VEH_POWERED_WAGON,
46 GBUG_UNKNOWN_CB_RESULT,
47 GBUG_VEH_CAPACITY,
48};
49
51 enum GRFListCompatibility {
52 GLC_ALL_GOOD,
53 GLC_COMPATIBLE,
54 GLC_NOT_FOUND,
55};
56
58 enum GRFPalette {
59 GRFP_USE_BIT = 0,
60 GRFP_GRF_OFFSET = 2,
61 GRFP_GRF_SIZE = 2,
62 GRFP_BLT_OFFSET = 4,
63 GRFP_BLT_SIZE = 1,
64
65 GRFP_USE_DOS = 0x0,
66 GRFP_USE_WINDOWS = 0x1,
67 GRFP_USE_MASK = 0x1,
68
69 GRFP_GRF_UNSET = 0x0 << GRFP_GRF_OFFSET,
70 GRFP_GRF_DOS = 0x1 << GRFP_GRF_OFFSET,
71 GRFP_GRF_WINDOWS = 0x2 << GRFP_GRF_OFFSET,
72 GRFP_GRF_ANY = GRFP_GRF_DOS | GRFP_GRF_WINDOWS,
73 GRFP_GRF_MASK = GRFP_GRF_ANY,
74
75 GRFP_BLT_UNSET = 0x0 << GRFP_BLT_OFFSET,
76 GRFP_BLT_32BPP = 0x1 << GRFP_BLT_OFFSET,
77 GRFP_BLT_MASK = GRFP_BLT_32BPP,
78};
79
80
82 struct GRFIdentifier {
83 uint32_t grfid;
84 MD5Hash md5sum;
85
86 GRFIdentifier() = default;
87 GRFIdentifier(const GRFIdentifier &other) = default;
88 GRFIdentifier(GRFIdentifier &&other) = default;
89 GRFIdentifier(uint32_t grfid, const MD5Hash &md5sum) : grfid(grfid), md5sum(md5sum) {}
90
91 GRFIdentifier& operator =(const GRFIdentifier &other) = default;
92
99 inline bool HasGrfIdentifier(uint32_t grfid, const MD5Hash *md5sum) const
100 {
101 if (this->grfid != grfid) return false;
102 if (md5sum == nullptr) return true;
103 return *md5sum == this->md5sum;
104 }
105};
106
108 struct GRFError {
109 GRFError(StringID severity, StringID message = 0);
110
111 std::string custom_message{};
112 std::string data{};
113 StringID message{};
114 StringID severity{};
115 std::array<uint32_t, 2> param_value{};
116};
117
119 enum GRFParameterType : uint8_t {
120 PTYPE_UINT_ENUM,
121 PTYPE_BOOL,
122 PTYPE_END,
123};
124
126 struct GRFParameterInfo {
131 explicit GRFParameterInfo(uint nr) : param_nr(nr) {}
132
133 GRFTextList name = {};
134 GRFTextList desc = {};
135
136 uint32_t min_value = 0;
137 uint32_t max_value = UINT32_MAX;
138 uint32_t def_value = 0;
139
140 GRFParameterType type = PTYPE_UINT_ENUM;
141
142 uint8_t param_nr;
143 uint8_t first_bit = 0;
144 uint8_t num_bit = 32;
145
146 bool complete_labels = false;
147
148 std::map<uint32_t, GRFTextList> value_names = {};
149
150 void Finalize();
151};
152
154 struct GRFConfig : ZeroedMemoryAllocator {
155 static constexpr uint8_t MAX_NUM_PARAMS = 0x80;
156
157 GRFConfig(const std::string &filename = std::string{});
158 GRFConfig(const GRFConfig &config);
159
160 /* Remove the copy assignment, as the default implementation will not do the right thing. */
161 GRFConfig &operator=(GRFConfig &rhs) = delete;
162
163 GRFIdentifier ident;
164 MD5Hash original_md5sum;
165 std::string filename;
166 GRFTextWrapper name;
167 GRFTextWrapper info;
168 GRFTextWrapper url;
169 std::optional<GRFError> error;
170
171 uint32_t version;
172 uint32_t min_loadable_version;
173 uint8_t flags;
174 GRFStatus status;
175 uint32_t grf_bugs;
176 uint8_t num_valid_params;
177 uint8_t palette;
178 bool has_param_defaults;
179 std::vector<std::optional<GRFParameterInfo>> param_info;
180 std::vector<uint32_t> param;
181
182 struct GRFConfig *next;
183
184 bool IsCompatible(uint32_t old_version) const;
185 void SetParams(std::span<const uint32_t> pars);
186 void CopyParams(const GRFConfig &src);
187
188 uint32_t GetValue(const GRFParameterInfo &info) const;
189 void SetValue(const GRFParameterInfo &info, uint32_t value);
190
191 std::optional<std::string> GetTextfile(TextfileType type) const;
192 const char *GetName() const;
193 const char *GetDescription() const;
194 const char *GetURL() const;
195
196 void SetParameterDefaults();
197 void SetSuitablePalette();
198 void FinalizeParameterInfo();
199};
200
202 enum FindGRFConfigMode {
203 FGCM_EXACT,
204 FGCM_COMPATIBLE,
205 FGCM_NEWEST,
206 FGCM_NEWEST_VALID,
207 FGCM_ANY,
208};
209
210extern GRFConfig *_all_grfs;
211extern GRFConfig *_grfconfig;
212extern GRFConfig *_grfconfig_newgame;
213extern GRFConfig *_grfconfig_static;
214extern uint _missing_extra_graphics;
215
217 struct NewGRFScanCallback {
219 virtual ~NewGRFScanCallback() = default;
221 virtual void OnNewGRFsScanned() = 0;
222};
223
224size_t GRFGetSizeOfDataSection(FileHandle &f);
225
226void ScanNewGRFFiles(NewGRFScanCallback *callback);
227const GRFConfig *FindGRFConfig(uint32_t grfid, FindGRFConfigMode mode, const MD5Hash *md5sum = nullptr, uint32_t desired_version = 0);
228 GRFConfig *GetGRFConfig(uint32_t grfid, uint32_t mask = 0xFFFFFFFF);
229 GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only);
230void AppendStaticGRFConfigs(GRFConfig **dst);
231void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el);
232void ClearGRFConfigList(GRFConfig **config);
233void ResetGRFConfig(bool defaults);
234 GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig);
235bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir = NEWGRF_DIR);
236std::string GRFBuildParamList(const GRFConfig *c);
237
238/* In newgrf_gui.cpp */
239void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config);
240void OpenGRFParameterWindow(bool is_baseset, GRFConfig *c, bool editable);
241
242void UpdateNewGRFScanStatus(uint num, const char *name);
243void UpdateNewGRFConfigPalette(int32_t new_value = 0);
244
245#endif /* NEWGRF_CONFIG_H */
alloc_type.hpp
Helper types related to the allocation of memory.
FileHandle
Definition fileio_type.h:158
ZeroedMemoryAllocator
Base class that provides memory initialization on dynamically created objects.
Definition alloc_type.hpp:86
fileio_type.h
Types for Standard In/Out file operations.
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition fileio_type.h:115
NEWGRF_DIR
@ NEWGRF_DIR
Subdirectory for all NewGRFs.
Definition fileio_type.h:124
GRFListCompatibility
GRFListCompatibility
Status of post-gameload GRF compatibility check.
Definition newgrf_config.h:51
GLC_COMPATIBLE
@ GLC_COMPATIBLE
Compatible (eg. the same ID, but different checksum) GRF found in at least one case.
Definition newgrf_config.h:53
GLC_ALL_GOOD
@ GLC_ALL_GOOD
All GRF needed by game are present.
Definition newgrf_config.h:52
GLC_NOT_FOUND
@ GLC_NOT_FOUND
At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)
Definition newgrf_config.h:54
UpdateNewGRFConfigPalette
void UpdateNewGRFConfigPalette(int32_t new_value=0)
Update the palettes of the graphics from the config file.
Definition newgrf_config.cpp:227
_all_grfs
GRFConfig * _all_grfs
First item in list of all scanned NewGRFs.
Definition newgrf_config.cpp:156
GRFPalette
GRFPalette
Information that can/has to be stored about a GRF's palette.
Definition newgrf_config.h:58
GRFP_GRF_UNSET
@ GRFP_GRF_UNSET
The NewGRF provided no information.
Definition newgrf_config.h:69
GRFP_BLT_UNSET
@ GRFP_BLT_UNSET
The NewGRF provided no information or doesn't care about a 32 bpp blitter.
Definition newgrf_config.h:75
GRFP_USE_DOS
@ GRFP_USE_DOS
The palette state is set to use the DOS palette.
Definition newgrf_config.h:65
GRFP_GRF_WINDOWS
@ GRFP_GRF_WINDOWS
The NewGRF says the Windows palette can be used.
Definition newgrf_config.h:71
GRFP_USE_WINDOWS
@ GRFP_USE_WINDOWS
The palette state is set to use the Windows palette.
Definition newgrf_config.h:66
GRFP_GRF_DOS
@ GRFP_GRF_DOS
The NewGRF says the DOS palette can be used.
Definition newgrf_config.h:70
GRFP_GRF_ANY
@ GRFP_GRF_ANY
The NewGRF says any palette can be used.
Definition newgrf_config.h:72
GRFP_BLT_MASK
@ GRFP_BLT_MASK
Bitmask to only get the blitter information.
Definition newgrf_config.h:77
GRFP_BLT_32BPP
@ GRFP_BLT_32BPP
The NewGRF prefers a 32 bpp blitter.
Definition newgrf_config.h:76
GRFP_BLT_OFFSET
@ GRFP_BLT_OFFSET
The offset of the GRFP_BLT data.
Definition newgrf_config.h:62
GRFP_GRF_SIZE
@ GRFP_GRF_SIZE
The size of the GRFP_GRF data.
Definition newgrf_config.h:61
GRFP_USE_BIT
@ GRFP_USE_BIT
The bit used for storing the palette to use.
Definition newgrf_config.h:59
GRFP_USE_MASK
@ GRFP_USE_MASK
Bitmask to get only the use palette use states.
Definition newgrf_config.h:67
GRFP_BLT_SIZE
@ GRFP_BLT_SIZE
The size of the GRFP_BLT data.
Definition newgrf_config.h:63
GRFP_GRF_OFFSET
@ GRFP_GRF_OFFSET
The offset of the GRFP_GRF data.
Definition newgrf_config.h:60
GRFP_GRF_MASK
@ GRFP_GRF_MASK
Bitmask to get only the NewGRF supplied information.
Definition newgrf_config.h:73
UpdateNewGRFScanStatus
void UpdateNewGRFScanStatus(uint num, const char *name)
Update the NewGRF scan status.
Definition newgrf_gui.cpp:2285
GetGRFConfig
GRFConfig * GetGRFConfig(uint32_t grfid, uint32_t mask=0xFFFFFFFF)
Retrieve a NewGRF from the current config by its grfid.
Definition newgrf_config.cpp:696
GCF_Flags
GCF_Flags
GRF config bit flags.
Definition newgrf_config.h:21
GCF_INIT_ONLY
@ GCF_INIT_ONLY
GRF file is processed up to GLS_INIT.
Definition newgrf_config.h:27
GCF_INVALID
@ GCF_INVALID
GRF is unusable with this version of OpenTTD.
Definition newgrf_config.h:29
GCF_STATIC
@ GCF_STATIC
GRF file is used statically (can be used in any MP game)
Definition newgrf_config.h:24
GCF_UNSAFE
@ GCF_UNSAFE
GRF file is unsafe for static usage.
Definition newgrf_config.h:23
GCF_COMPATIBLE
@ GCF_COMPATIBLE
GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)
Definition newgrf_config.h:25
GCF_RESERVED
@ GCF_RESERVED
GRF file passed GLS_RESERVE stage.
Definition newgrf_config.h:28
GCF_COPY
@ GCF_COPY
The data is copied from a grf in _all_grfs.
Definition newgrf_config.h:26
GCF_SYSTEM
@ GCF_SYSTEM
GRF file is an openttd-internal system grf.
Definition newgrf_config.h:22
GRFBuildParamList
std::string GRFBuildParamList(const GRFConfig *c)
Build a string containing space separated parameter values, and terminate.
Definition newgrf_config.cpp:709
ClearGRFConfigList
void ClearGRFConfigList(GRFConfig **config)
Clear a GRF Config list, freeing all nodes.
Definition newgrf_config.cpp:336
_missing_extra_graphics
uint _missing_extra_graphics
Number of sprites provided by the fallback extra GRF, i.e. missing in the baseset.
Definition newgrf_config.cpp:160
AppendToGRFConfigList
void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el)
Appends an element to a list of GRFs.
Definition newgrf_config.cpp:420
GRFStatus
GRFStatus
Status of GRF.
Definition newgrf_config.h:33
GCS_INITIALISED
@ GCS_INITIALISED
GRF file has been initialised.
Definition newgrf_config.h:37
GCS_DISABLED
@ GCS_DISABLED
GRF file is disabled.
Definition newgrf_config.h:35
GCS_NOT_FOUND
@ GCS_NOT_FOUND
GRF file was not found in the local cache.
Definition newgrf_config.h:36
GCS_UNKNOWN
@ GCS_UNKNOWN
The status of this grf file is unknown.
Definition newgrf_config.h:34
GCS_ACTIVATED
@ GCS_ACTIVATED
GRF file has been activated.
Definition newgrf_config.h:38
GRFBugs
GRFBugs
Encountered GRF bugs.
Definition newgrf_config.h:42
GBUG_VEH_POWERED_WAGON
@ GBUG_VEH_POWERED_WAGON
Powered wagon changed poweredness state when not inside a depot.
Definition newgrf_config.h:45
GBUG_VEH_REFIT
@ GBUG_VEH_REFIT
Articulated vehicles carry different cargoes resp. are differently refittable than specified in purch...
Definition newgrf_config.h:44
GBUG_VEH_LENGTH
@ GBUG_VEH_LENGTH
Length of rail vehicle changes when not inside a depot.
Definition newgrf_config.h:43
GBUG_UNKNOWN_CB_RESULT
@ GBUG_UNKNOWN_CB_RESULT
A callback returned an unknown/invalid result.
Definition newgrf_config.h:46
GBUG_VEH_CAPACITY
@ GBUG_VEH_CAPACITY
Capacity of vehicle changes when not refitting or arranging.
Definition newgrf_config.h:47
_grfconfig
GRFConfig * _grfconfig
First item in list of current GRF set up.
Definition newgrf_config.cpp:157
CopyGRFConfigList
GRFConfig ** CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only)
Copy a GRF Config list.
Definition newgrf_config.cpp:354
ResetGRFConfig
void ResetGRFConfig(bool defaults)
Reset the current GRF Config to either blank or newgame settings.
Definition newgrf_config.cpp:431
_grfconfig_static
GRFConfig * _grfconfig_static
First item in list of static GRF set up.
Definition newgrf_config.cpp:159
FillGRFDetails
bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir=NEWGRF_DIR)
Find the GRFID of a given grf, and calculate its md5sum.
Definition newgrf_config.cpp:304
FindGRFConfig
const GRFConfig * FindGRFConfig(uint32_t grfid, FindGRFConfigMode mode, const MD5Hash *md5sum=nullptr, uint32_t desired_version=0)
Find a NewGRF in the scanned list.
Definition newgrf_config.cpp:670
IsGoodGRFConfigList
GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig)
Check if all GRFs in the GRF config from a savegame can be loaded.
Definition newgrf_config.cpp:449
GRFParameterType
GRFParameterType
The possible types of a newgrf parameter.
Definition newgrf_config.h:119
PTYPE_UINT_ENUM
@ PTYPE_UINT_ENUM
The parameter allows a range of numbers, each of which can have a special name.
Definition newgrf_config.h:120
PTYPE_BOOL
@ PTYPE_BOOL
The parameter is either 0 or 1.
Definition newgrf_config.h:121
PTYPE_END
@ PTYPE_END
Invalid parameter type.
Definition newgrf_config.h:122
FindGRFConfigMode
FindGRFConfigMode
Method to find GRFs using FindGRFConfig.
Definition newgrf_config.h:202
FGCM_NEWEST
@ FGCM_NEWEST
Find newest Grf.
Definition newgrf_config.h:205
FGCM_ANY
@ FGCM_ANY
Use first found.
Definition newgrf_config.h:207
FGCM_NEWEST_VALID
@ FGCM_NEWEST_VALID
Find newest Grf, ignoring Grfs with GCF_INVALID set.
Definition newgrf_config.h:206
FGCM_EXACT
@ FGCM_EXACT
Only find Grfs matching md5sum.
Definition newgrf_config.h:203
FGCM_COMPATIBLE
@ FGCM_COMPATIBLE
Find best compatible Grf wrt. desired_version.
Definition newgrf_config.h:204
ScanNewGRFFiles
void ScanNewGRFFiles(NewGRFScanCallback *callback)
Scan for all NewGRFs.
Definition newgrf_config.cpp:652
AppendStaticGRFConfigs
void AppendStaticGRFConfigs(GRFConfig **dst)
Appends the static GRFs to a list of GRFs.
Definition newgrf_config.cpp:406
ShowNewGRFSettings
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
Setup the NewGRF gui.
Definition newgrf_gui.cpp:2019
GRFGetSizeOfDataSection
size_t GRFGetSizeOfDataSection(FileHandle &f)
Get the data section size of a GRF.
Definition newgrf_config.cpp:239
_grfconfig_newgame
GRFConfig * _grfconfig_newgame
First item in list of default GRF set up.
Definition newgrf_config.cpp:158
newgrf_text.h
Header of Action 04 "universal holder" structure and functions.
GRFTextWrapper
std::shared_ptr< GRFTextList > GRFTextWrapper
Reference counted wrapper around a GRFText pointer.
Definition newgrf_text_type.h:25
GRFTextList
std::vector< GRFText > GRFTextList
A GRF text with a list of translations.
Definition newgrf_text_type.h:23
strings_type.h
Types related to strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:16
GRFConfig
Information about GRF, used in the game and (part of it) in savegames.
Definition newgrf_config.h:154
GRFConfig::original_md5sum
MD5Hash original_md5sum
MD5 checksum of original file if only a 'compatible' file was loaded.
Definition newgrf_config.h:164
GRFConfig::SetParameterDefaults
void SetParameterDefaults()
Set the default value for all parameters as specified by action14.
Definition newgrf_config.cpp:117
GRFConfig::GetURL
const char * GetURL() const
Get the grf url.
Definition newgrf_config.cpp:111
GRFConfig::url
GRFTextWrapper url
NOSAVE: URL belonging to this GRF.
Definition newgrf_config.h:168
GRFConfig::palette
uint8_t palette
GRFPalette, bitset.
Definition newgrf_config.h:177
GRFConfig::flags
uint8_t flags
NOSAVE: GCF_Flags, bitset.
Definition newgrf_config.h:173
GRFConfig::GetDescription
const char * GetDescription() const
Get the grf info.
Definition newgrf_config.cpp:102
GRFConfig::info
GRFTextWrapper info
NOSAVE: GRF info (author, copyright, ...) (Action 0x08)
Definition newgrf_config.h:167
GRFConfig::param_info
std::vector< std::optional< GRFParameterInfo > > param_info
NOSAVE: extra information about the parameters.
Definition newgrf_config.h:179
GRFConfig::grf_bugs
uint32_t grf_bugs
NOSAVE: bugs in this GRF in this run,.
Definition newgrf_config.h:175
GRFConfig::version
uint32_t version
NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown.
Definition newgrf_config.h:171
GRFConfig::param
std::vector< uint32_t > param
GRF parameters.
Definition newgrf_config.h:180
GRFConfig::FinalizeParameterInfo
void FinalizeParameterInfo()
Finalize Action 14 info after file scan is finished.
Definition newgrf_config.cpp:148
GRFConfig::has_param_defaults
bool has_param_defaults
NOSAVE: did this newgrf specify any defaults for it's parameters.
Definition newgrf_config.h:178
GRFConfig::name
GRFTextWrapper name
NOSAVE: GRF name (Action 0x08)
Definition newgrf_config.h:166
GRFConfig::next
struct GRFConfig * next
NOSAVE: Next item in the linked list.
Definition newgrf_config.h:182
GRFConfig::status
GRFStatus status
NOSAVE: GRFStatus, enum.
Definition newgrf_config.h:174
GRFConfig::SetValue
void SetValue(const GRFParameterInfo &info, uint32_t value)
Set the value of the given user-changeable parameter.
Definition newgrf_config.cpp:192
GRFConfig::error
std::optional< GRFError > error
NOSAVE: Error/Warning during GRF loading (Action 0x0B)
Definition newgrf_config.h:169
GRFConfig::IsCompatible
bool IsCompatible(uint32_t old_version) const
Return whether this NewGRF can replace an older version of the same NewGRF.
Definition newgrf_config.cpp:73
GRFConfig::CopyParams
void CopyParams(const GRFConfig &src)
Copy the parameter information from the src config.
Definition newgrf_config.cpp:82
GRFConfig::GetTextfile
std::optional< std::string > GetTextfile(TextfileType type) const
Search a textfile file next to this NewGRF.
Definition newgrf_config.cpp:724
GRFConfig::num_valid_params
uint8_t num_valid_params
NOSAVE: Number of valid parameters (action 0x14)
Definition newgrf_config.h:176
GRFConfig::filename
std::string filename
Filename - either with or without full path.
Definition newgrf_config.h:165
GRFConfig::ident
GRFIdentifier ident
grfid and md5sum to uniquely identify newgrfs
Definition newgrf_config.h:163
GRFConfig::GetName
const char * GetName() const
Get the name of this grf.
Definition newgrf_config.cpp:92
GRFConfig::SetSuitablePalette
void SetSuitablePalette()
Set the palette of this GRFConfig to something suitable.
Definition newgrf_config.cpp:134
GRFConfig::min_loadable_version
uint32_t min_loadable_version
NOSAVE: Minimum compatible version a NewGRF can define.
Definition newgrf_config.h:172
GRFConfig::GetValue
uint32_t GetValue(const GRFParameterInfo &info) const
Get the value of the given user-changeable parameter.
Definition newgrf_config.cpp:176
GRFError
Information about why GRF had problems during initialisation.
Definition newgrf_config.h:108
GRFError::severity
StringID severity
Info / Warning / Error / Fatal.
Definition newgrf_config.h:114
GRFError::param_value
std::array< uint32_t, 2 > param_value
Values of GRF parameters to show for message and custom_message.
Definition newgrf_config.h:115
GRFError::message
StringID message
Default message.
Definition newgrf_config.h:113
GRFError::custom_message
std::string custom_message
Custom message (if present)
Definition newgrf_config.h:111
GRFError::data
std::string data
Additional data for message and custom_message.
Definition newgrf_config.h:112
GRFIdentifier
Basic data to distinguish a GRF.
Definition newgrf_config.h:82
GRFIdentifier::HasGrfIdentifier
bool HasGrfIdentifier(uint32_t grfid, const MD5Hash *md5sum) const
Does the identification match the provided values?
Definition newgrf_config.h:99
GRFIdentifier::grfid
uint32_t grfid
GRF ID (defined by Action 0x08)
Definition newgrf_config.h:83
GRFIdentifier::md5sum
MD5Hash md5sum
MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)
Definition newgrf_config.h:84
GRFParameterInfo
Information about one grf parameter.
Definition newgrf_config.h:126
GRFParameterInfo::complete_labels
bool complete_labels
True if all values have a label.
Definition newgrf_config.h:146
GRFParameterInfo::value_names
std::map< uint32_t, GRFTextList > value_names
Names for each value.
Definition newgrf_config.h:148
GRFParameterInfo::param_nr
uint8_t param_nr
GRF parameter to store content in.
Definition newgrf_config.h:142
GRFParameterInfo::min_value
uint32_t min_value
The minimal value this parameter can have.
Definition newgrf_config.h:136
GRFParameterInfo::num_bit
uint8_t num_bit
Number of bits to use for this parameter.
Definition newgrf_config.h:144
GRFParameterInfo::first_bit
uint8_t first_bit
First bit to use in the GRF parameter.
Definition newgrf_config.h:143
GRFParameterInfo::max_value
uint32_t max_value
The maximal value of this parameter.
Definition newgrf_config.h:137
GRFParameterInfo::type
GRFParameterType type
The type of this parameter.
Definition newgrf_config.h:140
GRFParameterInfo::Finalize
void Finalize()
Finalize Action 14 info after file scan is finished.
Definition newgrf_config.cpp:212
GRFParameterInfo::GRFParameterInfo
GRFParameterInfo(uint nr)
Create a new empty GRFParameterInfo object.
Definition newgrf_config.h:131
GRFParameterInfo::def_value
uint32_t def_value
Default value of this parameter.
Definition newgrf_config.h:138
GRFParameterInfo::name
GRFTextList name
The name of this parameter.
Definition newgrf_config.h:133
GRFParameterInfo::desc
GRFTextList desc
The description of this parameter.
Definition newgrf_config.h:134
NewGRFScanCallback
Callback for NewGRF scanning.
Definition newgrf_config.h:217
NewGRFScanCallback::~NewGRFScanCallback
virtual ~NewGRFScanCallback()=default
Make sure the right destructor gets called.
NewGRFScanCallback::OnNewGRFsScanned
virtual void OnNewGRFsScanned()=0
Called whenever the NewGRF scan completed.
textfile_type.h
Types related to textfiles.
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition textfile_type.h:14