author | celestar |
Wed, 13 Jun 2007 11:45:14 +0000 | |
branch | gamebalance |
changeset 9911 | 0b8b245a2391 |
child 6720 | 35756db7e577 |
child 7297 | 1df77fb920bd |
child 9626 | 79f2b5a0cdd7 |
permissions | -rw-r--r-- |
9911
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
1 |
/* $Id$ */ |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
2 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
3 |
/** @file newgrf_commons.h This file simplyfies and embeds a common mechanism of |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
4 |
* loading/saving and mapping of grf entities. |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
5 |
*/ |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
6 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
7 |
#ifndef NEWGRF_COMMONS_H |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
8 |
#define NEWGRF_COMMONS_H |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
9 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
10 |
/** |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
11 |
* Maps an entity id stored on the map to a GRF file. |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
12 |
* Entities are objects used ingame (houses, industries, industry tiles) for |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
13 |
* which we need to correlate the ids from the grf files with the ones in the |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
14 |
* the savegames themselves. |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
15 |
* An array of EntityIDMapping structs is saved with the savegame so |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
16 |
* that those GRFs can be loaded in a different order, or removed safely. The |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
17 |
* index in the array is the entity's ID stored on the map. |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
18 |
* |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
19 |
* The substitute ID is the ID of an original entity that should be used instead |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
20 |
* if the GRF containing the new entity is not available. |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
21 |
*/ |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
22 |
struct EntityIDMapping { |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
23 |
uint32 grfid; ///< The GRF ID of the file the entity belongs to |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
24 |
uint8 entity_id; ///< The entity ID within the GRF file |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
25 |
uint8 substitute_id; ///< The (original) entity ID to use if this GRF is not available |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
26 |
}; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
27 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
28 |
class OverrideManagerBase |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
29 |
{ |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
30 |
protected: |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
31 |
uint16 *entity_overrides; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
32 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
33 |
uint16 max_offset; ///< what is the length of the original entity's array of specs |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
34 |
uint16 max_new_entities; ///< what is the amount of entities, old and new summed |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
35 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
36 |
uint16 invalid_ID; ///< ID used to dected invalid entities; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
37 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
38 |
virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
39 |
public: |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
40 |
EntityIDMapping *mapping_ID; ///< mapping of ids from grf files. Public out of convenience |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
41 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
42 |
OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
43 |
virtual ~OverrideManagerBase(); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
44 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
45 |
void ResetOverride(); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
46 |
void ResetMapping(); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
47 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
48 |
void Add(uint8 local_id, uint entity_type); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
49 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
50 |
uint16 GetSubstituteID(byte entity_id); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
51 |
uint16 GetID(uint8 grf_local_id, uint32 grfid); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
52 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
53 |
inline uint16 GetMaxMapping() { return max_new_entities; }; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
54 |
inline uint16 GetMaxOffset() { return max_offset; }; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
55 |
}; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
56 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
57 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
58 |
struct HouseSpec; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
59 |
class HouseOverrideManager : public OverrideManagerBase |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
60 |
{ |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
61 |
public: |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
62 |
HouseOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) : OverrideManagerBase(offset, maximum, invalid) {}; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
63 |
void SetEntitySpec(const HouseSpec *hs); |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
64 |
}; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
65 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
66 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
67 |
extern HouseOverrideManager _house_mngr; |
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
68 |
|
0b8b245a2391
(svn r10135) [gamebalance] -Sync: r9700:9900 from trunk
celestar
parents:
diff
changeset
|
69 |
#endif /* NEWGRF_COMMONS_H */ |