Files
@ r19963:c6d969678d57
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf.h - annotation
r19963:c6d969678d57
6.1 KiB
text/x-c
(svn r24919) -Codechange: Remove useless noisy grf debug messages.
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 | 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 r6143:9ed364174dfd r11076:462de50d5ea7 r18007:5ef6f0cf0861 r18844:a10105b3df75 r19361:172ad5e17c1b r19362:44a1cca54def r5475:3f5cd13d1b63 r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18138:6c1d420b5b29 r18138:6c1d420b5b29 r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r18087:1bd0e337907f r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6359:99cac4de410b r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r14900:c679fdaeebe6 r5587:034e5e185dc2 r6541:639dad125026 r6541:639dad125026 r6541:639dad125026 r6541:639dad125026 r12423:199e8b46a11b r18268:18fcafb2ffd2 r6541:639dad125026 r6541:639dad125026 r5587:034e5e185dc2 r8541:0e9423226281 r15068:718936ee3a0c r15068:718936ee3a0c r15068:718936ee3a0c r8541:0e9423226281 r15068:718936ee3a0c r15068:718936ee3a0c r15068:718936ee3a0c r15068:718936ee3a0c r8541:0e9423226281 r8541:0e9423226281 r8541:0e9423226281 r18668:b656d614c4fd r8541:0e9423226281 r14402:be0791dad1ac r14402:be0791dad1ac r14402:be0791dad1ac r14402:be0791dad1ac r14607:4bad45b6a4eb r8541:0e9423226281 r15072:0c171c464368 r15072:0c171c464368 r15072:0c171c464368 r15072:0c171c464368 r18737:1ee35da7fa2f r8541:0e9423226281 r8541:0e9423226281 r11291:64ad346852e6 r11291:64ad346852e6 r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r9390:aab57f0a7820 r5475:3f5cd13d1b63 r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r12423:199e8b46a11b r19361:172ad5e17c1b r5475:3f5cd13d1b63 r8164:c60d7059d0da r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r15047:549cfe65e8b5 r5475:3f5cd13d1b63 r15732:516b1939e794 r15732:516b1939e794 r15732:516b1939e794 r15732:516b1939e794 r15956:d2b10191aed2 r14851:b3915c863ff3 r14607:4bad45b6a4eb r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6348:a905c3e6d8fa r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6143:9ed364174dfd r19362:44a1cca54def r19362:44a1cca54def r11076:462de50d5ea7 r19362:44a1cca54def r14402:be0791dad1ac r12423:199e8b46a11b r18087:1bd0e337907f r18087:1bd0e337907f r16474:f9eb86a38244 r16474:f9eb86a38244 r12423:199e8b46a11b r15173:a59afd6301a6 r13733:844aadb7fd6d r13733:844aadb7fd6d r13733:844aadb7fd6d r14141:092094f6122c r19361:172ad5e17c1b r19361:172ad5e17c1b r19361:172ad5e17c1b r14141:092094f6122c r14141:092094f6122c r14141:092094f6122c r14141:092094f6122c r14141:092094f6122c r14141:092094f6122c r14141:092094f6122c r14141:092094f6122c r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r8403:8b4006f704c5 r8403:8b4006f704c5 r8403:8b4006f704c5 r8403:8b4006f704c5 r8403:8b4006f704c5 r8403:8b4006f704c5 r8403:8b4006f704c5 r6914:0e1dfc32f04f r6914:0e1dfc32f04f r16142:e91bfb8299b5 r6914:0e1dfc32f04f r6914:0e1dfc32f04f r8403:8b4006f704c5 r6769:0e5b094df012 r6769:0e5b094df012 r18844:a10105b3df75 r19944:25a78576fb5e r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r18844:a10105b3df75 r6769:0e5b094df012 r6914:0e1dfc32f04f r5475:3f5cd13d1b63 r19020:24d71054fe13 r19020:24d71054fe13 r18007:5ef6f0cf0861 r5475:3f5cd13d1b63 r10571:99cb9a95b4cf r16055:f2d805b29aac r17884:c09c40617963 r5475:3f5cd13d1b63 r11870:92eb16f6d311 r5475:3f5cd13d1b63 r18307:9b4849582975 r6541:639dad125026 r8656:d17cc62502ce r13958:4df52fd52d03 r8656:d17cc62502ce 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.h Base for the NewGRF implementation. */
#ifndef NEWGRF_H
#define NEWGRF_H
#include "cargotype.h"
#include "rail_type.h"
#include "fileio_type.h"
#include "core/bitmath_func.hpp"
#include "core/alloc_type.hpp"
#include "core/smallvec_type.hpp"
/**
* List of different canal 'features'.
* Each feature gets an entry in the canal spritegroup table
*/
enum CanalFeature {
CF_WATERSLOPE,
CF_LOCKS,
CF_DIKES,
CF_ICON,
CF_DOCKS,
CF_RIVER_SLOPE,
CF_RIVER_EDGE,
CF_RIVER_GUI,
CF_BUOY,
CF_END,
};
/** Canal properties local to the NewGRF */
struct CanalProperties {
uint8 callback_mask; ///< Bitmask of canal callbacks that have to be called.
uint8 flags; ///< Flags controlling display.
};
enum GrfLoadingStage {
GLS_FILESCAN,
GLS_SAFETYSCAN,
GLS_LABELSCAN,
GLS_INIT,
GLS_RESERVE,
GLS_ACTIVATION,
GLS_END,
};
DECLARE_POSTFIX_INCREMENT(GrfLoadingStage)
enum GrfMiscBit {
GMB_DESERT_TREES_FIELDS = 0, // Unsupported.
GMB_DESERT_PAVED_ROADS = 1,
GMB_FIELD_BOUNDING_BOX = 2, // Unsupported.
GMB_TRAIN_WIDTH_32_PIXELS = 3, ///< Use 32 pixels per train vehicle in depot gui and vehicle details. Never set in the global variable; @see GRFFile::traininfo_vehicle_width
GMB_AMBIENT_SOUND_CALLBACK = 4,
GMB_CATENARY_ON_3RD_TRACK = 5, // Unsupported.
};
enum GrfSpecFeature {
GSF_TRAINS,
GSF_ROADVEHICLES,
GSF_SHIPS,
GSF_AIRCRAFT,
GSF_STATIONS,
GSF_CANALS,
GSF_BRIDGES,
GSF_HOUSES,
GSF_GLOBALVAR,
GSF_INDUSTRYTILES,
GSF_INDUSTRIES,
GSF_CARGOES,
GSF_SOUNDFX,
GSF_AIRPORTS,
GSF_SIGNALS,
GSF_OBJECTS,
GSF_RAILTYPES,
GSF_AIRPORTTILES,
GSF_END,
GSF_FAKE_TOWNS = GSF_END, ///< Fake town GrfSpecFeature for NewGRF debugging (parent scope)
GSF_FAKE_END, ///< End of the fake features
GSF_INVALID = 0xFF, ///< An invalid spec feature
};
static const uint32 INVALID_GRFID = 0xFFFFFFFF;
struct GRFLabel {
byte label;
uint32 nfo_line;
size_t pos;
struct GRFLabel *next;
};
/** Dynamic data of a loaded NewGRF */
struct GRFFile : ZeroedMemoryAllocator {
char *filename;
bool is_ottdfile;
uint32 grfid;
byte grf_version;
uint sound_offset;
uint16 num_sounds;
struct StationSpec **stations;
struct HouseSpec **housespec;
struct IndustrySpec **industryspec;
struct IndustryTileSpec **indtspec;
struct ObjectSpec **objectspec;
struct AirportSpec **airportspec;
struct AirportTileSpec **airtspec;
uint32 param[0x80];
uint param_end; ///< one more than the highest set parameter
GRFLabel *label; ///< Pointer to the first label. This is a linked list, not an array.
SmallVector<CargoLabel, 4> cargo_list; ///< Cargo translation table (local ID -> label)
uint8 cargo_map[NUM_CARGO]; ///< Inverse cargo translation table (CargoID -> local ID)
SmallVector<RailTypeLabel, 4> railtype_list; ///< Railtype translation table
RailType railtype_map[RAILTYPE_END];
CanalProperties canal_local_properties[CF_END]; ///< Canal properties as set by this NewGRF
struct LanguageMap *language_map; ///< Mappings related to the languages.
int traininfo_vehicle_pitch; ///< Vertical offset for draing train images in depot GUI and vehicle details
uint traininfo_vehicle_width; ///< Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details
uint32 grf_features; ///< Bitset of GrfSpecFeature the grf uses
PriceMultipliers price_base_multipliers; ///< Price base multipliers as set by the grf.
GRFFile(const struct GRFConfig *config);
~GRFFile();
/** Get GRF Parameter with range checking */
uint32 GetParam(uint number) const
{
/* Note: We implicitly test for number < lengthof(this->param) and return 0 for invalid parameters.
* In fact this is the more important test, as param is zeroed anyway. */
assert(this->param_end <= lengthof(this->param));
return (number < this->param_end) ? this->param[number] : 0;
}
};
enum ShoreReplacement {
SHORE_REPLACE_NONE, ///< No shore sprites were replaced.
SHORE_REPLACE_ACTION_5, ///< Shore sprites were replaced by Action5.
SHORE_REPLACE_ACTION_A, ///< Shore sprites were replaced by ActionA (using grass tiles for the corner-shores).
SHORE_REPLACE_ONLY_NEW, ///< Only corner-shores were loaded by Action5 (openttd(w/d).grf only).
};
struct GRFLoadedFeatures {
bool has_2CC; ///< Set if any vehicle is loaded which uses 2cc (two company colours).
uint64 used_liveries; ///< Bitmask of #LiveryScheme used by the defined engines.
bool has_newhouses; ///< Set if there are any newhouses loaded.
bool has_newindustries; ///< Set if there are any newindustries loaded.
ShoreReplacement shore; ///< It which way shore sprites were replaced.
};
/**
* Check for grf miscellaneous bits
* @param bit The bit to check.
* @return Whether the bit is set.
*/
static inline bool HasGrfMiscBit(GrfMiscBit bit)
{
extern byte _misc_grf_features;
return HasBit(_misc_grf_features, bit);
}
/* Indicates which are the newgrf features currently loaded ingame */
extern GRFLoadedFeatures _loaded_newgrf_features;
byte GetGRFContainerVersion();
void LoadNewGRFFile(struct GRFConfig *config, uint file_index, GrfLoadingStage stage, Subdirectory subdir);
void LoadNewGRF(uint load_index, uint file_index);
void ReloadNewGRFData(); // in saveload/afterload.cpp
void ResetNewGRFData();
void ResetPersistentNewGRFData();
void CDECL grfmsg(int severity, const char *str, ...) WARN_FORMAT(2, 3);
bool GetGlobalVariable(byte param, uint32 *value, const GRFFile *grffile);
StringID MapGRFStringID(uint32 grfid, StringID str);
void ShowNewGRFError();
#endif /* NEWGRF_H */
|