OpenTTD
Public Member Functions
IndustryOverrideManager Class Reference
Inheritance diagram for IndustryOverrideManager:
OverrideManagerBase

Public Member Functions

 IndustryOverrideManager (uint16 offset, uint16 maximum, uint16 invalid)
virtual uint16 AddEntityID (byte grf_local_id, uint32 grfid, byte substitute_id)
 Method to find an entity ID and to mark it as reserved for the Industry to be included.
virtual uint16 GetID (uint8 grf_local_id, uint32 grfid) const
 Return the ID (if ever available) of a previously inserted entity.
void SetEntitySpec (IndustrySpec *inds)
 Method to install the new industry data in its proper slot The slot assignment is internal of this method, since it requires checking what is available.
- Public Member Functions inherited from OverrideManagerBase
 OverrideManagerBase (uint16 offset, uint16 maximum, uint16 invalid)
 Constructor of generic class.
virtual ~OverrideManagerBase ()
 Destructor of the generic class.
void ResetOverride ()
 Resets the override, which is used while initializing game.
void ResetMapping ()
 Resets the mapping, which is used while initializing game.
void Add (uint8 local_id, uint32 grfid, uint entity_type)
 Since the entity IDs defined by the GRF file does not necessarily correlate to those used by the game, the IDs used for overriding old entities must be translated when the entity spec is set.
uint32 GetGRFID (uint16 entity_id) const
 Gives the GRFID of the file the entity belongs to.
uint16 GetSubstituteID (uint16 entity_id) const
 Gives the substitute of the entity, as specified by the grf file.
uint16 GetMaxMapping () const
uint16 GetMaxOffset () const

Additional Inherited Members

- Data Fields inherited from OverrideManagerBase
EntityIDMappingmapping_ID
 mapping of ids from grf files. Public out of convenience
- Protected Member Functions inherited from OverrideManagerBase
virtual bool CheckValidNewID (uint16 testid)
- Protected Attributes inherited from OverrideManagerBase
uint16 * entity_overrides
uint32 * grfid_overrides
uint16 max_offset
 what is the length of the original entity's array of specs
uint16 max_new_entities
 what is the amount of entities, old and new summed
uint16 invalid_ID
 ID used to detected invalid entities;.

Detailed Description

Definition at line 236 of file newgrf_commons.h.

Member Function Documentation

uint16 IndustryOverrideManager::AddEntityID ( byte  grf_local_id,
uint32  grfid,
byte  substitute_id 
)
virtual

Method to find an entity ID and to mark it as reserved for the Industry to be included.

Parameters
grf_local_idID used by the grf file for pre-installation work (equivalent of TTDPatch's setid
grfidID of the current grf file
substitute_idindustry from which data has been copied
Returns
a free entity id (slotid) if ever one has been found, or Invalid_ID marker otherwise

Reimplemented from OverrideManagerBase.

Definition at line 227 of file newgrf_commons.cpp.

References IndustrySpec::enabled, EntityIDMapping::entity_id, GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, EntityIDMapping::grfid, OverrideManagerBase::invalid_ID, OverrideManagerBase::mapping_ID, OverrideManagerBase::max_new_entities, OverrideManagerBase::max_offset, and EntityIDMapping::substitute_id.

Referenced by SetEntitySpec().

uint16 IndustryOverrideManager::GetID ( uint8  grf_local_id,
uint32  grfid 
) const
virtual

Return the ID (if ever available) of a previously inserted entity.

Parameters
grf_local_idID of this entity within the grfID
grfidID of the grf file
Returns
the ID of the candidate, of the Invalid flag item ID

Reimplemented from OverrideManagerBase.

Definition at line 207 of file newgrf_commons.cpp.

References OverrideManagerBase::invalid_ID, and OverrideManagerBase::max_offset.

Referenced by MapNewGRFIndustryType(), and SetEntitySpec().

void IndustryOverrideManager::SetEntitySpec ( IndustrySpec inds)

Method to install the new industry data in its proper slot The slot assignment is internal of this method, since it requires checking what is available.

Parameters
indsIndustryspec that comes from the grf decoding process

Definition at line 262 of file newgrf_commons.cpp.

References AddEntityID(), IndustrySpec::enabled, GetID(), IndustrySpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, grfmsg(), OverrideManagerBase::invalid_ID, GRFFilePropsBase< Tcnt >::local_id, and GRFFileProps::override.

Referenced by FinaliseIndustriesArray().


The documentation for this class was generated from the following files: