1

/* $Id$ */

     2

     3

/** @file newgrf_commons.h This file simplyfies and embeds a common mechanism of

     4

 * loading/saving and mapping of grf entities.

     5

 */

     6

     7

#ifndef NEWGRF_COMMONS_H

     8

#define NEWGRF_COMMONS_H

     9

    10

/**

    11

 * Maps an entity id stored on the map to a GRF file.

    12

 * Entities are objects used ingame (houses, industries, industry tiles) for

    13

 * which we need to correlate the ids from the grf files with the ones in the

    14

 * the savegames themselves.

    15

 * An array of EntityIDMapping structs is saved with the savegame so

    16

 * that those GRFs can be loaded in a different order, or removed safely. The

    17

 * index in the array is the entity's ID stored on the map.

    18

 *

    19

 * The substitute ID is the ID of an original entity that should be used instead

    20

 * if the GRF containing the new entity is not available.

    21

 */

    22

struct EntityIDMapping {

    23

	uint32 grfid;          ///< The GRF ID of the file the entity belongs to

    24

	uint8  entity_id;      ///< The entity ID within the GRF file

    25

	uint8  substitute_id;  ///< The (original) entity ID to use if this GRF is not available

    26

};

    27

    28

class OverrideManagerBase {

    29

protected:

    30

	uint16 *entity_overrides;

    31

    32

	uint16 max_offset;       ///< what is the length of the original entity's array of specs

    33

	uint16 max_new_entities; ///< what is the amount of entities, old and new summed

    34

    35

	uint16 invalid_ID;       ///< ID used to dected invalid entities;

    36

    37

public:

    38

	EntityIDMapping *mapping_ID; ///< mapping of ids from grf files.  Public out of convenience

    39

    40

	OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid);

    41

	virtual ~OverrideManagerBase();

    42

    43

	void ResetOverride();

    44

	void ResetMapping();

    45

    46

	void Add(uint8 local_id, uint entity_type);

    47

	virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);

    48

    49

	uint16 GetSubstituteID(byte entity_id);

    50

	uint16 GetID(uint8 grf_local_id, uint32 grfid);

    51

    52

	inline uint16 GetMaxMapping() { return max_new_entities; }

    53

	inline uint16 GetMaxOffset() { return max_offset; }

    54

};

    55

    56

    57

struct HouseSpec;

    58

class HouseOverrideManager : public OverrideManagerBase {

    59

public:

    60

	HouseOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

    61

			OverrideManagerBase(offset, maximum, invalid) {}

    62

	void SetEntitySpec(const HouseSpec *hs);

    63

};

    64

    65

    66

struct IndustrySpec;

    67

class IndustryOverrideManager : public OverrideManagerBase {

    68

public:

    69

	IndustryOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

    70

			OverrideManagerBase(offset, maximum, invalid) {}

    71

    72

	virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);

    73

	void SetEntitySpec(const IndustrySpec *inds);

    74

};

    75

    76

    77

struct IndustryTileSpec;

    78

class IndustryTileOverrideManager : public OverrideManagerBase {

    79

public:

    80

	IndustryTileOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

    81

			OverrideManagerBase(offset, maximum, invalid) {}

    82

    83

	void SetEntitySpec(const IndustryTileSpec *indts);

    84

};

    85

    86

extern HouseOverrideManager _house_mngr;

    87

extern IndustryOverrideManager _industry_mngr;

    88

extern IndustryTileOverrideManager _industile_mngr;

    89

    90

uint32 GetTerrainType(TileIndex tile);

    91

TileIndex GetNearbyTile(byte parameter, TileIndex tile);

    92

    93

#endif /* NEWGRF_COMMONS_H */