Files
@ r28396:ef195b601c72
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_commons.h - annotation
r28396:ef195b601c72
13.0 KiB
text/x-c
Fix: Pass townnameparts as parameter when testing townname based companyname. (#11685)
Length of returned string could vary and pass/fail the length check with a different
string than the final selection.
Length of returned string could vary and pass/fail the length check with a different
string than the final selection.
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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r15610:623a23fb6560 r15610:623a23fb6560 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17850:7726e086e93b r17853:b905f907c347 r18023:2bce2aecd4c8 r10355:1d372454f71c r17671:6321f2c5c4f2 r15743:4f6cef458ee3 r15747:606d1ec00369 r15747:606d1ec00369 r15747:606d1ec00369 r15743:4f6cef458ee3 r15743:4f6cef458ee3 r6629:10368ea45a15 r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r22339:80cd128a4dcb r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r18092:0c570d9f37b7 r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r27737:728d55b97775 r27737:728d55b97775 r27737:728d55b97775 r27737:728d55b97775 r27737:728d55b97775 r17728:6a6e98f25cac r27737:728d55b97775 r27737:728d55b97775 r17728:6a6e98f25cac r27737:728d55b97775 r27737:728d55b97775 r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17728:6a6e98f25cac r17728:6a6e98f25cac r18093:bb567a02767f r18093:bb567a02767f r18093:bb567a02767f r18093:bb567a02767f r18093:bb567a02767f r18093:bb567a02767f r17671:6321f2c5c4f2 r17728:6a6e98f25cac r17671:6321f2c5c4f2 r17728:6a6e98f25cac r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r23607:36c15679007d r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r18352:6c15d75d1ab9 r18352:6c15d75d1ab9 r17671:6321f2c5c4f2 r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r23607:36c15679007d r17728:6a6e98f25cac r17728:6a6e98f25cac r27737:728d55b97775 r27737:728d55b97775 r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r23536:ce42deb0b32d r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r17728:6a6e98f25cac r23538:8df50944b27a r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r17671:6321f2c5c4f2 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r27737:728d55b97775 r27254:8bf1b3d96bdc r27254:8bf1b3d96bdc r6629:10368ea45a15 r6629:10368ea45a15 r7325:df3b64d742c5 r6629:10368ea45a15 r27737:728d55b97775 r27737:728d55b97775 r6629:10368ea45a15 r27737:728d55b97775 r27737:728d55b97775 r6629:10368ea45a15 r27737:728d55b97775 r27942:f7389062d120 r6629:10368ea45a15 r6629:10368ea45a15 r26807:8c1f4aace1b4 r6629:10368ea45a15 r27737:728d55b97775 r27372:06d384d76bd2 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r27737:728d55b97775 r27737:728d55b97775 r6629:10368ea45a15 r27737:728d55b97775 r27737:728d55b97775 r27737:728d55b97775 r6629:10368ea45a15 r27737:728d55b97775 r27737:728d55b97775 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r7325:df3b64d742c5 r6629:10368ea45a15 r27737:728d55b97775 r7325:df3b64d742c5 r23505:2c24909d1448 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6629:10368ea45a15 r6835:9051f7024392 r7325:df3b64d742c5 r7325:df3b64d742c5 r27737:728d55b97775 r7325:df3b64d742c5 r6835:9051f7024392 r27737:728d55b97775 r27737:728d55b97775 r23505:2c24909d1448 r7667:3c17bebdab13 r6835:9051f7024392 r6835:9051f7024392 r7000:2cb5bda647b1 r7000:2cb5bda647b1 r7325:df3b64d742c5 r7632:40eddc1d4853 r27971:716575a43d7f r7325:df3b64d742c5 r27737:728d55b97775 r7325:df3b64d742c5 r7325:df3b64d742c5 r7325:df3b64d742c5 r7000:2cb5bda647b1 r7000:2cb5bda647b1 r14851:b3915c863ff3 r14851:b3915c863ff3 r14851:b3915c863ff3 r27737:728d55b97775 r14851:b3915c863ff3 r14851:b3915c863ff3 r14851:b3915c863ff3 r14851:b3915c863ff3 r14851:b3915c863ff3 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r27971:716575a43d7f r14606:2cf1bcd611f7 r27737:728d55b97775 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r15950:217ba3ee892a r15950:217ba3ee892a r15950:217ba3ee892a r27971:716575a43d7f r15950:217ba3ee892a r27737:728d55b97775 r15950:217ba3ee892a r15950:217ba3ee892a r15950:217ba3ee892a r15950:217ba3ee892a r15950:217ba3ee892a r6629:10368ea45a15 r6835:9051f7024392 r7000:2cb5bda647b1 r14851:b3915c863ff3 r14606:2cf1bcd611f7 r15950:217ba3ee892a r6629:10368ea45a15 r27737:728d55b97775 r17853:b905f907c347 r27737:728d55b97775 r27737:728d55b97775 r27737:728d55b97775 r6801:3c6b56e07296 r27737:728d55b97775 r27737:728d55b97775 r27737:728d55b97775 r18294:67a72ead8996 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15721:10f89584959d r25707:226494aad20a r15761:680dbdd50e09 r15761:680dbdd50e09 r15761:680dbdd50e09 r15761:680dbdd50e09 r15761:680dbdd50e09 r15761:680dbdd50e09 r27737:728d55b97775 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15721:10f89584959d r15721:10f89584959d r15721:10f89584959d r15751:f4fe02ef4406 r15721:10f89584959d r27737:728d55b97775 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r15751:f4fe02ef4406 r27737:728d55b97775 r27737:728d55b97775 r14606:2cf1bcd611f7 r14606:2cf1bcd611f7 r6629:10368ea45a15 | /*
* 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_commons.h This file simplyfies and embeds a common mechanism of
* loading/saving and mapping of grf entities.
*/
#ifndef NEWGRF_COMMONS_H
#define NEWGRF_COMMONS_H
#include "sprite.h"
#include "core/alloc_type.hpp"
#include "command_type.h"
#include "direction_type.h"
#include "company_type.h"
/** Context for tile accesses */
enum TileContext {
TCX_NORMAL, ///< Nothing special.
TCX_UPPER_HALFTILE, ///< Querying information about the upper part of a tile with halftile foundation.
TCX_ON_BRIDGE, ///< Querying information about stuff on the bridge (via some bridgehead).
};
/**
* Flags to enable register usage in sprite layouts.
*/
enum TileLayoutFlags {
TLF_NOTHING = 0x00,
TLF_DODRAW = 0x01, ///< Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero.
TLF_SPRITE = 0x02, ///< Add signed offset to sprite from register TileLayoutRegisters::sprite.
TLF_PALETTE = 0x04, ///< Add signed offset to palette from register TileLayoutRegisters::palette.
TLF_CUSTOM_PALETTE = 0x08, ///< Palette is from Action 1 (moved to SPRITE_MODIFIER_CUSTOM_SPRITE in palette during loading).
TLF_BB_XY_OFFSET = 0x10, ///< Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta.parent[0..1].
TLF_BB_Z_OFFSET = 0x20, ///< Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta.parent[2].
TLF_CHILD_X_OFFSET = 0x10, ///< Add signed offset to child sprite X positions from register TileLayoutRegisters::delta.child[0].
TLF_CHILD_Y_OFFSET = 0x20, ///< Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta.child[1].
TLF_SPRITE_VAR10 = 0x40, ///< Resolve sprite with a specific value in variable 10.
TLF_PALETTE_VAR10 = 0x80, ///< Resolve palette with a specific value in variable 10.
TLF_KNOWN_FLAGS = 0xFF, ///< Known flags. Any unknown set flag will disable the GRF.
/** Flags which are still required after loading the GRF. */
TLF_DRAWING_FLAGS = ~TLF_CUSTOM_PALETTE,
/** Flags which do not work for the (first) ground sprite. */
TLF_NON_GROUND_FLAGS = TLF_BB_XY_OFFSET | TLF_BB_Z_OFFSET | TLF_CHILD_X_OFFSET | TLF_CHILD_Y_OFFSET,
/** Flags which refer to using multiple action-1-2-3 chains. */
TLF_VAR10_FLAGS = TLF_SPRITE_VAR10 | TLF_PALETTE_VAR10,
/** Flags which require resolving the action-1-2-3 chain for the sprite, even if it is no action-1 sprite. */
TLF_SPRITE_REG_FLAGS = TLF_DODRAW | TLF_SPRITE | TLF_BB_XY_OFFSET | TLF_BB_Z_OFFSET | TLF_CHILD_X_OFFSET | TLF_CHILD_Y_OFFSET,
/** Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palette. */
TLF_PALETTE_REG_FLAGS = TLF_PALETTE,
};
DECLARE_ENUM_AS_BIT_SET(TileLayoutFlags)
/**
* Determines which sprite to use from a spriteset for a specific construction stage.
* @param construction_stage Construction stage 0 - 3.
* @param num_sprites Number of available sprites to select stage from.
* @return Sprite to use
*/
static inline uint GetConstructionStageOffset(uint construction_stage, uint num_sprites)
{
assert(num_sprites > 0);
if (num_sprites > 4) num_sprites = 4;
switch (construction_stage) {
case 0: return 0;
case 1: return num_sprites > 2 ? 1 : 0;
case 2: return num_sprites > 2 ? num_sprites - 2 : 0;
case 3: return num_sprites - 1;
default: NOT_REACHED();
}
}
/**
* Additional modifiers for items in sprite layouts.
*/
struct TileLayoutRegisters {
TileLayoutFlags flags; ///< Flags defining which members are valid and to be used.
uint8_t dodraw; ///< Register deciding whether the sprite shall be drawn at all. Non-zero means drawing.
uint8_t sprite; ///< Register specifying a signed offset for the sprite.
uint8_t palette; ///< Register specifying a signed offset for the palette.
uint16_t max_sprite_offset; ///< Maximum offset to add to the sprite. (limited by size of the spriteset)
uint16_t max_palette_offset; ///< Maximum offset to add to the palette. (limited by size of the spriteset)
union {
uint8_t parent[3]; ///< Registers for signed offsets for the bounding box position of parent sprites.
uint8_t child[2]; ///< Registers for signed offsets for the position of child sprites.
} delta;
uint8_t sprite_var10; ///< Value for variable 10 when resolving the sprite.
uint8_t palette_var10; ///< Value for variable 10 when resolving the palette.
};
static const uint TLR_MAX_VAR10 = 7; ///< Maximum value for var 10.
/**
* NewGRF supplied spritelayout.
* In contrast to #DrawTileSprites this struct is for allocated
* layouts on the heap. It allocates data and frees them on destruction.
*/
struct NewGRFSpriteLayout : ZeroedMemoryAllocator, DrawTileSprites {
const TileLayoutRegisters *registers;
/**
* Number of sprites in all referenced spritesets.
* If these numbers are inconsistent, then this is 0 and the real values are in \c registers.
*/
uint consistent_max_offset;
void Allocate(uint num_sprites);
void AllocateRegisters();
void Clone(const DrawTileSeqStruct *source);
void Clone(const NewGRFSpriteLayout *source);
/**
* Clone a spritelayout.
* @param source The spritelayout to copy.
*/
void Clone(const DrawTileSprites *source)
{
assert(source != nullptr && this != source);
this->ground = source->ground;
this->Clone(source->seq);
}
virtual ~NewGRFSpriteLayout()
{
free(this->seq);
free(this->registers);
}
/**
* Tests whether this spritelayout needs preprocessing by
* #PrepareLayout() and #ProcessRegisters(), or whether it can be
* used directly.
* @return true if preprocessing is needed
*/
bool NeedsPreprocessing() const
{
return this->registers != nullptr;
}
uint32_t PrepareLayout(uint32_t orig_offset, uint32_t newgrf_ground_offset, uint32_t newgrf_offset, uint constr_stage, bool separate_ground) const;
void ProcessRegisters(uint8_t resolved_var10, uint32_t resolved_sprite, bool separate_ground) const;
/**
* Returns the result spritelayout after preprocessing.
* @pre #PrepareLayout() and #ProcessRegisters() need calling first.
* @return result spritelayout
*/
const DrawTileSeqStruct *GetLayout(PalSpriteID *ground) const
{
DrawTileSeqStruct *front = result_seq.data();
*ground = front->image;
return front + 1;
}
private:
static std::vector<DrawTileSeqStruct> result_seq; ///< Temporary storage when preprocessing spritelayouts.
};
/**
* Maps an entity id stored on the map to a GRF file.
* Entities are objects used ingame (houses, industries, industry tiles) for
* which we need to correlate the ids from the grf files with the ones in the
* the savegames themselves.
* An array of EntityIDMapping structs is saved with the savegame so
* that those GRFs can be loaded in a different order, or removed safely. The
* index in the array is the entity's ID stored on the map.
*
* The substitute ID is the ID of an original entity that should be used instead
* if the GRF containing the new entity is not available.
*/
struct EntityIDMapping {
uint32_t grfid; ///< The GRF ID of the file the entity belongs to
uint16_t entity_id; ///< The entity ID within the GRF file
uint16_t substitute_id; ///< The (original) entity ID to use if this GRF is not available
};
class OverrideManagerBase {
protected:
std::vector<uint16_t> entity_overrides;
std::vector<uint32_t> grfid_overrides;
uint16_t max_offset; ///< what is the length of the original entity's array of specs
uint16_t max_entities; ///< what is the amount of entities, old and new summed
uint16_t invalid_id; ///< ID used to detected invalid entities
virtual bool CheckValidNewID([[maybe_unused]] uint16_t testid) { return true; }
public:
std::vector<EntityIDMapping> mappings; ///< mapping of ids from grf files. Public out of convenience
OverrideManagerBase(uint16_t offset, uint16_t maximum, uint16_t invalid);
virtual ~OverrideManagerBase() = default;
void ResetOverride();
void ResetMapping();
void Add(uint16_t local_id, uint32_t grfid, uint entity_type);
virtual uint16_t AddEntityID(uint16_t grf_local_id, uint32_t grfid, uint16_t substitute_id);
uint32_t GetGRFID(uint16_t entity_id) const;
uint16_t GetSubstituteID(uint16_t entity_id) const;
virtual uint16_t GetID(uint16_t grf_local_id, uint32_t grfid) const;
inline uint16_t GetMaxMapping() const { return this->max_entities; }
inline uint16_t GetMaxOffset() const { return this->max_offset; }
};
struct HouseSpec;
class HouseOverrideManager : public OverrideManagerBase {
public:
HouseOverrideManager(uint16_t offset, uint16_t maximum, uint16_t invalid) :
OverrideManagerBase(offset, maximum, invalid) {}
void SetEntitySpec(const HouseSpec *hs);
};
struct IndustrySpec;
class IndustryOverrideManager : public OverrideManagerBase {
public:
IndustryOverrideManager(uint16_t offset, uint16_t maximum, uint16_t invalid) :
OverrideManagerBase(offset, maximum, invalid) {}
uint16_t AddEntityID(uint16_t grf_local_id, uint32_t grfid, uint16_t substitute_id) override;
uint16_t GetID(uint16_t grf_local_id, uint32_t grfid) const override;
void SetEntitySpec(IndustrySpec *inds);
};
struct IndustryTileSpec;
class IndustryTileOverrideManager : public OverrideManagerBase {
protected:
bool CheckValidNewID(uint16_t testid) override { return testid != 0xFF; }
public:
IndustryTileOverrideManager(uint16_t offset, uint16_t maximum, uint16_t invalid) :
OverrideManagerBase(offset, maximum, invalid) {}
void SetEntitySpec(const IndustryTileSpec *indts);
};
struct AirportSpec;
class AirportOverrideManager : public OverrideManagerBase {
public:
AirportOverrideManager(uint16_t offset, uint16_t maximum, uint16_t invalid) :
OverrideManagerBase(offset, maximum, invalid) {}
void SetEntitySpec(AirportSpec *inds);
};
struct AirportTileSpec;
class AirportTileOverrideManager : public OverrideManagerBase {
protected:
bool CheckValidNewID(uint16_t testid) override { return testid != 0xFF; }
public:
AirportTileOverrideManager(uint16_t offset, uint16_t maximum, uint16_t invalid) :
OverrideManagerBase(offset, maximum, invalid) {}
void SetEntitySpec(const AirportTileSpec *ats);
};
struct ObjectSpec;
class ObjectOverrideManager : public OverrideManagerBase {
protected:
bool CheckValidNewID(uint16_t testid) override { return testid != 0xFF; }
public:
ObjectOverrideManager(uint16_t offset, uint16_t maximum, uint16_t invalid) :
OverrideManagerBase(offset, maximum, invalid) {}
void SetEntitySpec(ObjectSpec *spec);
};
extern HouseOverrideManager _house_mngr;
extern IndustryOverrideManager _industry_mngr;
extern IndustryTileOverrideManager _industile_mngr;
extern AirportOverrideManager _airport_mngr;
extern AirportTileOverrideManager _airporttile_mngr;
extern ObjectOverrideManager _object_mngr;
uint32_t GetTerrainType(TileIndex tile, TileContext context = TCX_NORMAL);
TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets = true, Axis axis = INVALID_AXIS);
uint32_t GetNearbyTileInformation(TileIndex tile, bool grf_version8);
uint32_t GetCompanyInfo(CompanyID owner, const struct Livery *l = nullptr);
CommandCost GetErrorMessageFromLocationCallbackResult(uint16_t cb_res, const GRFFile *grffile, StringID default_error);
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res);
bool ConvertBooleanCallback(const struct GRFFile *grffile, uint16_t cbid, uint16_t cb_res);
bool Convert8bitBooleanCallback(const struct GRFFile *grffile, uint16_t cbid, uint16_t cb_res);
/**
* Data related to the handling of grf files.
* @tparam Tcnt Number of spritegroups
*/
template <size_t Tcnt>
struct GRFFilePropsBase {
GRFFilePropsBase() : local_id(0), grffile(nullptr)
{
/* The lack of some compilers to provide default constructors complying to the specs
* requires us to zero the stuff ourself. */
memset(spritegroup, 0, sizeof(spritegroup));
}
uint16_t local_id; ///< id defined by the grf file for this entity
const struct GRFFile *grffile; ///< grf file that introduced this entity
const struct SpriteGroup *spritegroup[Tcnt]; ///< pointer to the different sprites of the entity
};
/** Data related to the handling of grf files. */
struct GRFFileProps : GRFFilePropsBase<1> {
/** Set all default data constructor for the props. */
GRFFileProps(uint16_t subst_id = 0) :
GRFFilePropsBase<1>(), subst_id(subst_id), override(subst_id)
{
}
uint16_t subst_id;
uint16_t override; ///< id of the entity been replaced by
};
#endif /* NEWGRF_COMMONS_H */
|