Files
@ r19864:c0b662df5bb7
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_config.h - annotation
r19864:c0b662df5bb7
11.2 KiB
text/x-c
(svn r24819) -Update from WebTranslator v3.0:
basque - 3 changes by lutxiketa
malay - 51 changes by richz
polish - 3 changes by wojteks86
russian - 1 changes by Lone_Wolf
basque - 3 changes by lutxiketa
malay - 51 changes by richz
polish - 3 changes by wojteks86
russian - 1 changes by Lone_Wolf
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r6348:a905c3e6d8fa r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r8142:8414f11ec81b r14662:8798e984ee81 r15585:151b3e97ecca r17403:bbaee031fd60 r18007:5ef6f0cf0861 r19064:0f7af43d9a9f r6139:0128edd33976 r8799:2ce178790a9f r6248:b940b09d7ab8 r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r17067:d8300f20b7a7 r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r8799:2ce178790a9f r6248:b940b09d7ab8 r6229:a69564e4eb2e r6229:a69564e4eb2e r6229:a69564e4eb2e r6229:a69564e4eb2e r18737:1ee35da7fa2f r6248:b940b09d7ab8 r6229:a69564e4eb2e r9704:108fa337b182 r9704:108fa337b182 r15816:67664bff2b7d r18668:b656d614c4fd r15816:67664bff2b7d r18294:67a72ead8996 r9704:108fa337b182 r9704:108fa337b182 r8799:2ce178790a9f r9704:108fa337b182 r8799:2ce178790a9f r8799:2ce178790a9f r18737:1ee35da7fa2f r6248:b940b09d7ab8 r6229:a69564e4eb2e r15583:941df37daa12 r15583:941df37daa12 r15583:941df37daa12 r15584:5fce62ffde01 r15584:5fce62ffde01 r18162:11349b218a54 r18162:11349b218a54 r15583:941df37daa12 r15583:941df37daa12 r15583:941df37daa12 r15583:941df37daa12 r15584:5fce62ffde01 r15584:5fce62ffde01 r15584:5fce62ffde01 r15584:5fce62ffde01 r15584:5fce62ffde01 r15584:5fce62ffde01 r18162:11349b218a54 r18162:11349b218a54 r18162:11349b218a54 r18162:11349b218a54 r15583:941df37daa12 r15583:941df37daa12 r15583:941df37daa12 r8799:2ce178790a9f r6248:b940b09d7ab8 r8799:2ce178790a9f r8799:2ce178790a9f r15196:77940844856f r15610:623a23fb6560 r15610:623a23fb6560 r15196:77940844856f r15196:77940844856f r15196:77940844856f r15196:77940844856f r18782:6453522c2154 r15196:77940844856f r15196:77940844856f r15196:77940844856f r15196:77940844856f r15196:77940844856f r6248:b940b09d7ab8 r5765:cfade44195bc r8799:2ce178790a9f r14662:8798e984ee81 r14662:8798e984ee81 r15578:4df52cbd221a r14662:8798e984ee81 r14662:8798e984ee81 r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r11828:ec9e606e896e r6248:b940b09d7ab8 r6139:0128edd33976 r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15907:70e379b9c8d1 r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r15585:151b3e97ecca r19401:96b7d1ecdefe r15588:8aad267fa5ef r15588:8aad267fa5ef r15588:8aad267fa5ef r19401:96b7d1ecdefe r15585:151b3e97ecca r15585:151b3e97ecca r17403:bbaee031fd60 r17403:bbaee031fd60 r17403:bbaee031fd60 r17403:bbaee031fd60 r17403:bbaee031fd60 r17403:bbaee031fd60 r17403:bbaee031fd60 r17403:bbaee031fd60 r8799:2ce178790a9f r14667:a7ee51a0cfe3 r14667:a7ee51a0cfe3 r15578:4df52cbd221a r14667:a7ee51a0cfe3 r14667:a7ee51a0cfe3 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r17403:bbaee031fd60 r17403:bbaee031fd60 r18637:6db0bce1fa51 r16248:5f6ecb94e4a6 r5475:3f5cd13d1b63 r16248:5f6ecb94e4a6 r16247:0b3fc1f1c234 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r16248:5f6ecb94e4a6 r15585:151b3e97ecca r16248:5f6ecb94e4a6 r5475:3f5cd13d1b63 r16248:5f6ecb94e4a6 r7882:cdf03a4ac84a r7882:cdf03a4ac84a r14701:3d820af7badc r18403:c5ec10907d18 r14701:3d820af7badc r14701:3d820af7badc r18637:6db0bce1fa51 r15582:6daf5f9adce7 r15907:70e379b9c8d1 r15582:6daf5f9adce7 r19401:96b7d1ecdefe r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r16246:b0e8840a555e r16246:b0e8840a555e r16246:b0e8840a555e r16247:0b3fc1f1c234 r16246:b0e8840a555e r17067:d8300f20b7a7 r16246:b0e8840a555e r16246:b0e8840a555e r16246:b0e8840a555e r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r8799:2ce178790a9f r5475:3f5cd13d1b63 r17971:2adf1b724154 r17971:2adf1b724154 r17971:2adf1b724154 r17971:2adf1b724154 r17971:2adf1b724154 r17971:2adf1b724154 r17971:2adf1b724154 r17971:2adf1b724154 r19020:24d71054fe13 r19020:24d71054fe13 r17974:7006269a8b97 r15874:dfd0ea646f2d r16247:0b3fc1f1c234 r10781:758b3ae29fdd r6956:6398843f1341 r5475:3f5cd13d1b63 r6108:580a9fc2a546 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r15320:d9619cca229a r18007:5ef6f0cf0861 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6348:a905c3e6d8fa r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r17629:21e9dfd343cd r5475:3f5cd13d1b63 r17403:bbaee031fd60 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r17978:c07585e51a28 r18567:f74e88c29847 r17978:c07585e51a28 r5475:3f5cd13d1b63 | /* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file newgrf_config.h Functions to find and configure NewGRFs. */
#ifndef NEWGRF_CONFIG_H
#define NEWGRF_CONFIG_H
#include "strings_type.h"
#include "core/alloc_type.hpp"
#include "core/smallmap_type.hpp"
#include "misc/countedptr.hpp"
#include "fileio_type.h"
#include "textfile_type.h"
/** GRF config bit flags */
enum GCF_Flags {
GCF_SYSTEM, ///< GRF file is an openttd-internal system grf
GCF_UNSAFE, ///< GRF file is unsafe for static usage
GCF_STATIC, ///< GRF file is used statically (can be used in any MP game)
GCF_COMPATIBLE, ///< GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)
GCF_COPY, ///< The data is copied from a grf in _all_grfs
GCF_INIT_ONLY, ///< GRF file is processed up to GLS_INIT
GCF_RESERVED, ///< GRF file passed GLS_RESERVE stage
GCF_INVALID, ///< GRF is unusable with this version of OpenTTD
};
/** Status of GRF */
enum GRFStatus {
GCS_UNKNOWN, ///< The status of this grf file is unknown
GCS_DISABLED, ///< GRF file is disabled
GCS_NOT_FOUND, ///< GRF file was not found in the local cache
GCS_INITIALISED, ///< GRF file has been initialised
GCS_ACTIVATED, ///< GRF file has been activated
};
/** Encountered GRF bugs */
enum GRFBugs {
GBUG_VEH_LENGTH, ///< Length of rail vehicle changes when not inside a depot
GBUG_VEH_REFIT, ///< Articulated vehicles carry different cargoes resp. are differently refittable than specified in purchase list
GBUG_VEH_POWERED_WAGON, ///< Powered wagon changed poweredness state when not inside a depot
GBUG_UNKNOWN_CB_RESULT, ///< A callback returned an unknown/invalid result
};
/** Status of post-gameload GRF compatibility check */
enum GRFListCompatibility {
GLC_ALL_GOOD, ///< All GRF needed by game are present
GLC_COMPATIBLE, ///< Compatible (eg. the same ID, but different chacksum) GRF found in at least one case
GLC_NOT_FOUND, ///< At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)
};
/** Information that can/has to be stored about a GRF's palette. */
enum GRFPalette {
GRFP_USE_BIT = 0, ///< The bit used for storing the palette to use.
GRFP_GRF_OFFSET = 2, ///< The offset of the GRFP_GRF data.
GRFP_GRF_SIZE = 2, ///< The size of the GRFP_GRF data.
GRFP_BLT_OFFSET = 4, ///< The offset of the GRFP_BLT data.
GRFP_BLT_SIZE = 1, ///< The size of the GRFP_BLT data.
GRFP_USE_DOS = 0x0, ///< The palette state is set to use the DOS palette.
GRFP_USE_WINDOWS = 0x1, ///< The palette state is set to use the Windows palette.
GRFP_USE_MASK = 0x1, ///< Bitmask to get only the use palette use states.
GRFP_GRF_UNSET = 0x0 << GRFP_GRF_OFFSET, ///< The NewGRF provided no information.
GRFP_GRF_DOS = 0x1 << GRFP_GRF_OFFSET, ///< The NewGRF says the DOS palette can be used.
GRFP_GRF_WINDOWS = 0x2 << GRFP_GRF_OFFSET, ///< The NewGRF says the Windows palette can be used.
GRFP_GRF_ANY = GRFP_GRF_DOS | GRFP_GRF_WINDOWS, ///< The NewGRF says any palette can be used.
GRFP_GRF_MASK = GRFP_GRF_ANY, ///< Bitmask to get only the NewGRF supplied information.
GRFP_BLT_UNSET = 0x0 << GRFP_BLT_OFFSET, ///< The NewGRF provided no information or doesn't care about a 32 bpp blitter.
GRFP_BLT_32BPP = 0x1 << GRFP_BLT_OFFSET, ///< The NewGRF prefers a 32 bpp blitter.
GRFP_BLT_MASK = GRFP_BLT_32BPP, ///< Bitmask to only get the blitter information.
};
/** Basic data to distinguish a GRF. Used in the server list window */
struct GRFIdentifier {
uint32 grfid; ///< GRF ID (defined by Action 0x08)
uint8 md5sum[16]; ///< MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)
/**
* Does the identification match the provided values?
* @param grfid Expected grfid.
* @param md5sum Expected md5sum, may be \c NULL (in which case, do not check it).
* @return the object has the provided grfid and md5sum.
*/
inline bool HasGrfIdentifier(uint32 grfid, const uint8 *md5sum) const
{
if (this->grfid != grfid) return false;
if (md5sum == NULL) return true;
return memcmp(md5sum, this->md5sum, sizeof(this->md5sum)) == 0;
}
};
/** Information about why GRF had problems during initialisation */
struct GRFError : ZeroedMemoryAllocator {
GRFError(StringID severity, StringID message = 0);
GRFError(const GRFError &error);
~GRFError();
char *custom_message; ///< Custom message (if present)
char *data; ///< Additional data for message and custom_message
StringID message; ///< Default message
StringID severity; ///< Info / Warning / Error / Fatal
uint32 param_value[2]; ///< Values of GRF parameters to show for message and custom_message
};
/** The possible types of a newgrf parameter. */
enum GRFParameterType {
PTYPE_UINT_ENUM, ///< The parameter allows a range of numbers, each of which can have a special name
PTYPE_BOOL, ///< The parameter is either 0 or 1
PTYPE_END, ///< Invalid parameter type
};
/** Information about one grf parameter. */
struct GRFParameterInfo {
GRFParameterInfo(uint nr);
GRFParameterInfo(GRFParameterInfo &info);
~GRFParameterInfo();
struct GRFText *name; ///< The name of this parameter
struct GRFText *desc; ///< The description of this parameter
GRFParameterType type; ///< The type of this parameter
uint32 min_value; ///< The minimal value this parameter can have
uint32 max_value; ///< The maximal value of this parameter
uint32 def_value; ///< Default value of this parameter
byte param_nr; ///< GRF parameter to store content in
byte first_bit; ///< First bit to use in the GRF parameter
byte num_bit; ///< Number of bits to use for this parameter
SmallMap<uint32, struct GRFText *, 8> value_names; ///< Names for each value.
bool complete_labels; ///< True if all values have a label.
uint32 GetValue(struct GRFConfig *config) const;
void SetValue(struct GRFConfig *config, uint32 value);
void Finalize();
};
/** Reference counted wrapper around a GRFText pointer. */
struct GRFTextWrapper : public SimpleCountedObject {
struct GRFText *text; ///< The actual text
GRFTextWrapper();
~GRFTextWrapper();
};
/** Information about GRF, used in the game and (part of it) in savegames */
struct GRFConfig : ZeroedMemoryAllocator {
GRFConfig(const char *filename = NULL);
GRFConfig(const GRFConfig &config);
~GRFConfig();
GRFIdentifier ident; ///< grfid and md5sum to uniquely identify newgrfs
uint8 original_md5sum[16]; ///< MD5 checksum of original file if only a 'compatible' file was loaded
char *filename; ///< Filename - either with or without full path
GRFTextWrapper *name; ///< NOSAVE: GRF name (Action 0x08)
GRFTextWrapper *info; ///< NOSAVE: GRF info (author, copyright, ...) (Action 0x08)
GRFTextWrapper *url; ///< NOSAVE: URL belonging to this GRF.
GRFError *error; ///< NOSAVE: Error/Warning during GRF loading (Action 0x0B)
uint32 version; ///< NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown
uint32 min_loadable_version; ///< NOSAVE: Minimum compatible version a NewGRF can define
uint8 flags; ///< NOSAVE: GCF_Flags, bitset
GRFStatus status; ///< NOSAVE: GRFStatus, enum
uint32 grf_bugs; ///< NOSAVE: bugs in this GRF in this run, @see enum GRFBugs
uint32 param[0x80]; ///< GRF parameters
uint8 num_params; ///< Number of used parameters
uint8 num_valid_params; ///< NOSAVE: Number of valid parameters (action 0x14)
uint8 palette; ///< GRFPalette, bitset
SmallVector<GRFParameterInfo *, 4> param_info; ///< NOSAVE: extra information about the parameters
bool has_param_defaults; ///< NOSAVE: did this newgrf specify any defaults for it's parameters
struct GRFConfig *next; ///< NOSAVE: Next item in the linked list
bool IsOpenTTDBaseGRF() const;
const char *GetTextfile(TextfileType type) const;
const char *GetName() const;
const char *GetDescription() const;
const char *GetURL() const;
void SetParameterDefaults();
void SetSuitablePalette();
void FinalizeParameterInfo();
};
/** Method to find GRFs using FindGRFConfig */
enum FindGRFConfigMode {
FGCM_EXACT, ///< Only find Grfs matching md5sum
FGCM_COMPATIBLE, ///< Find best compatible Grf wrt. desired_version
FGCM_NEWEST, ///< Find newest Grf
FGCM_NEWEST_VALID,///< Find newest Grf, ignoring Grfs with GCF_INVALID set
FGCM_ANY, ///< Use first found
};
extern GRFConfig *_all_grfs; ///< First item in list of all scanned NewGRFs
extern GRFConfig *_grfconfig; ///< First item in list of current GRF set up
extern GRFConfig *_grfconfig_newgame; ///< First item in list of default GRF set up
extern GRFConfig *_grfconfig_static; ///< First item in list of static GRF set up
/** Callback for NewGRF scanning. */
struct NewGRFScanCallback {
/** Make sure the right destructor gets called. */
virtual ~NewGRFScanCallback() {}
/** Called whenever the NewGRF scan completed. */
virtual void OnNewGRFsScanned() = 0;
};
size_t GRFGetSizeOfDataSection(FILE *f);
void ScanNewGRFFiles(NewGRFScanCallback *callback);
void CheckForMissingSprites();
const GRFConfig *FindGRFConfig(uint32 grfid, FindGRFConfigMode mode, const uint8 *md5sum = NULL, uint32 desired_version = 0);
GRFConfig *GetGRFConfig(uint32 grfid, uint32 mask = 0xFFFFFFFF);
GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only);
void AppendStaticGRFConfigs(GRFConfig **dst);
void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el);
void ClearGRFConfigList(GRFConfig **config);
void ResetGRFConfig(bool defaults);
GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig);
bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir = NEWGRF_DIR);
char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last);
/* In newgrf_gui.cpp */
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config);
#ifdef ENABLE_NETWORK
/** For communication about GRFs over the network */
#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"
GRFTextWrapper *FindUnknownGRFName(uint32 grfid, uint8 *md5sum, bool create);
#endif /* ENABLE_NETWORK */
void UpdateNewGRFScanStatus(uint num, const char *name);
bool UpdateNewGRFConfigPalette(int32 p1 = 0);
#endif /* NEWGRF_CONFIG_H */
|