author | skidd13 |
Tue, 20 Nov 2007 14:11:19 +0000 | |
changeset 8428 | f8300c908bd9 |
parent 8369 | 4decac386a96 |
child 8954 | ca1d17502817 |
permissions | -rw-r--r-- |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
1 |
/* $Id$ */ |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
2 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
3 |
/** @file newgrf_commons.h This file simplyfies and embeds a common mechanism of |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
4 |
* loading/saving and mapping of grf entities. |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
5 |
*/ |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
6 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
7 |
#ifndef NEWGRF_COMMONS_H |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
8 |
#define NEWGRF_COMMONS_H |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
9 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
10 |
/** |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
11 |
* Maps an entity id stored on the map to a GRF file. |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
12 |
* Entities are objects used ingame (houses, industries, industry tiles) for |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
13 |
* which we need to correlate the ids from the grf files with the ones in the |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
14 |
* the savegames themselves. |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
15 |
* An array of EntityIDMapping structs is saved with the savegame so |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
16 |
* that those GRFs can be loaded in a different order, or removed safely. The |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
17 |
* index in the array is the entity's ID stored on the map. |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
18 |
* |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
19 |
* The substitute ID is the ID of an original entity that should be used instead |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
20 |
* if the GRF containing the new entity is not available. |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
21 |
*/ |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
22 |
struct EntityIDMapping { |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
23 |
uint32 grfid; ///< The GRF ID of the file the entity belongs to |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
24 |
uint8 entity_id; ///< The entity ID within the GRF file |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
25 |
uint8 substitute_id; ///< The (original) entity ID to use if this GRF is not available |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
26 |
}; |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
27 |
|
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
28 |
class OverrideManagerBase { |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
29 |
protected: |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
30 |
uint16 *entity_overrides; |
8369
4decac386a96
(svn r11423) -Codechange: store grfid when adding an override
glx
parents:
8163
diff
changeset
|
31 |
uint32 *grfid_overrides; |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
32 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
33 |
uint16 max_offset; ///< what is the length of the original entity's array of specs |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
34 |
uint16 max_new_entities; ///< what is the amount of entities, old and new summed |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
35 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
36 |
uint16 invalid_ID; ///< ID used to dected invalid entities; |
8128
9fe288a99e99
(svn r11163) -Codechange: Verify that the IndustryTileOverrideManager skip the magic value of 0xFF when assigning a new tileID. This is really important, since the value is reserved for water checking.
belugas
parents:
7821
diff
changeset
|
37 |
virtual bool CheckValidNewID(uint16 testid) { return true; } |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
38 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
39 |
public: |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
40 |
EntityIDMapping *mapping_ID; ///< mapping of ids from grf files. Public out of convenience |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
41 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
42 |
OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
43 |
virtual ~OverrideManagerBase(); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
44 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
45 |
void ResetOverride(); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
46 |
void ResetMapping(); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
47 |
|
8369
4decac386a96
(svn r11423) -Codechange: store grfid when adding an override
glx
parents:
8163
diff
changeset
|
48 |
void Add(uint8 local_id, uint32 grfid, uint entity_type); |
7331
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
49 |
virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id); |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
50 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
51 |
uint16 GetSubstituteID(byte entity_id); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
52 |
uint16 GetID(uint8 grf_local_id, uint32 grfid); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
53 |
|
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
54 |
inline uint16 GetMaxMapping() { return max_new_entities; } |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
55 |
inline uint16 GetMaxOffset() { return max_offset; } |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
56 |
}; |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
57 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
58 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
59 |
struct HouseSpec; |
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
60 |
class HouseOverrideManager : public OverrideManagerBase { |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
61 |
public: |
7331
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
62 |
HouseOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) : |
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
63 |
OverrideManagerBase(offset, maximum, invalid) {} |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
64 |
void SetEntitySpec(const HouseSpec *hs); |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
65 |
}; |
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
66 |
|
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
67 |
|
7331
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
68 |
struct IndustrySpec; |
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
69 |
class IndustryOverrideManager : public OverrideManagerBase { |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
70 |
public: |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
71 |
IndustryOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) : |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
72 |
OverrideManagerBase(offset, maximum, invalid) {} |
7331
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
73 |
|
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
74 |
virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id); |
8163
0a8d78012096
(svn r11198) -Fix: When industry override is not possible because it is already been overridden, mark the new candidate as not being an override
belugas
parents:
8128
diff
changeset
|
75 |
void SetEntitySpec(IndustrySpec *inds); |
7331
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
76 |
}; |
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
77 |
|
7496
628e1191ee45
(svn r10256) -Add: Addition of IndustryTileOverrideManager
belugas
parents:
7331
diff
changeset
|
78 |
|
628e1191ee45
(svn r10256) -Add: Addition of IndustryTileOverrideManager
belugas
parents:
7331
diff
changeset
|
79 |
struct IndustryTileSpec; |
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
80 |
class IndustryTileOverrideManager : public OverrideManagerBase { |
8128
9fe288a99e99
(svn r11163) -Codechange: Verify that the IndustryTileOverrideManager skip the magic value of 0xFF when assigning a new tileID. This is really important, since the value is reserved for water checking.
belugas
parents:
7821
diff
changeset
|
81 |
protected: |
9fe288a99e99
(svn r11163) -Codechange: Verify that the IndustryTileOverrideManager skip the magic value of 0xFF when assigning a new tileID. This is really important, since the value is reserved for water checking.
belugas
parents:
7821
diff
changeset
|
82 |
virtual bool CheckValidNewID(uint16 testid) { return testid != 0xFF; } |
7821
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
83 |
public: |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
84 |
IndustryTileOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) : |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
85 |
OverrideManagerBase(offset, maximum, invalid) {} |
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
86 |
|
5388aa2cd1d2
(svn r10688) -Cleanup: coding style cleanups missed in the last few cleanups.
rubidium
parents:
7496
diff
changeset
|
87 |
void SetEntitySpec(const IndustryTileSpec *indts); |
7496
628e1191ee45
(svn r10256) -Add: Addition of IndustryTileOverrideManager
belugas
parents:
7331
diff
changeset
|
88 |
}; |
628e1191ee45
(svn r10256) -Add: Addition of IndustryTileOverrideManager
belugas
parents:
7331
diff
changeset
|
89 |
|
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
90 |
extern HouseOverrideManager _house_mngr; |
7331
0a7f00fed4e6
(svn r10074) -Add: Addition of IndustryOverrideManager as well as the basic (and unfinished) support for callbacks for industries
belugas
parents:
7323
diff
changeset
|
91 |
extern IndustryOverrideManager _industry_mngr; |
7496
628e1191ee45
(svn r10256) -Add: Addition of IndustryTileOverrideManager
belugas
parents:
7331
diff
changeset
|
92 |
extern IndustryTileOverrideManager _industile_mngr; |
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
93 |
|
7297
1df77fb920bd
(svn r10040) -Codechange: Make the function GetTerrainType public, as other functions require it
belugas
parents:
7125
diff
changeset
|
94 |
uint32 GetTerrainType(TileIndex tile); |
7323
b2871568db92
(svn r10066) -Codechange: Expose function GetNearbyTile by moving it to newgrf_commons.[cpp|h]. Will be used by industries in a few.
belugas
parents:
7297
diff
changeset
|
95 |
TileIndex GetNearbyTile(byte parameter, TileIndex tile); |
7297
1df77fb920bd
(svn r10040) -Codechange: Make the function GetTerrainType public, as other functions require it
belugas
parents:
7125
diff
changeset
|
96 |
|
7125
4ce0c7a12a3f
(svn r9850) -Codechange: Introduction of the Override/Substitute manager. Currently only used for newhouses.
belugas
parents:
diff
changeset
|
97 |
#endif /* NEWGRF_COMMONS_H */ |