1

/* $Id$ */

     2

     3

/** @file newgrf_commons.cpp Implementation of the class OverrideManagerBase

     4

 * and its descendance, present and futur

     5

 */

     6

     7

#include "stdafx.h"

     8

#include "openttd.h"

     9

#include "variables.h"

    10

#include "landscape.h"

    11

#include "town.h"

    12

#include "industry.h"

    13

#include "newgrf.h"

    14

#include "newgrf_commons.h"

    15

#include "tile_map.h"

    16

#include "station_map.h"

    17

#include "settings_type.h"

    18

    19

/** Constructor of generic class

    20

 * @param offset end of original data for this entity. i.e: houses = 110

    21

 * @param maximum of entities this manager can deal with. i.e: houses = 512

    22

 * @param invalid is the ID used to identify an invalid entity id

    23

 */

    24

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

    25

{

    26

	max_offset = offset;

    27

	max_new_entities = maximum;

    28

	invalid_ID = invalid;

    29

    30

	mapping_ID = CallocT<EntityIDMapping>(max_new_entities);

    31

	entity_overrides = MallocT<uint16>(max_offset);

    32

	memset(entity_overrides, invalid, sizeof(entity_overrides));

    33

	grfid_overrides = CallocT<uint32>(max_offset);

    34

}

    35

    36

/** Destructor of the generic class.

    37

 * Frees allocated memory of constructor

    38

 */

    39

OverrideManagerBase::~OverrideManagerBase()

    40

{

    41

	free(mapping_ID);

    42

	free(entity_overrides);

    43

	free(grfid_overrides);

    44

}

    45

    46

/** Since the entity IDs defined by the GRF file does not necessarily correlate

    47

 * to those used by the game, the IDs used for overriding old entities must be

    48

 * translated when the entity spec is set.

    49

 * @param local_id ID in grf file

    50

 * @param grfid  ID of the grf file

    51

 * @param entity_type original entity type

    52

 */

    53

void OverrideManagerBase::Add(uint8 local_id, uint32 grfid, uint entity_type)

    54

{

    55

	assert(entity_type < max_offset);

    56

	/* An override can be set only once */

    57

	if (entity_overrides[entity_type] != invalid_ID) return;

    58

	entity_overrides[entity_type] = local_id;

    59

	grfid_overrides[entity_type] = grfid;

    60

}

    61

    62

/** Resets the mapping, which is used while initializing game */

    63

void OverrideManagerBase::ResetMapping()

    64

{

    65

	memset(mapping_ID, 0, (max_new_entities - 1) * sizeof(EntityIDMapping));

    66

}

    67

    68

/** Resets the override, which is used while initializing game */

    69

void OverrideManagerBase::ResetOverride()

    70

{

    71

	for (uint16 i = 0; i < max_offset; i++) {

    72

		entity_overrides[i] = invalid_ID;

    73

		grfid_overrides[i] = 0;

    74

	}

    75

}

    76

    77

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

    78

 * @param grf_local_id ID of this enity withing the grfID

    79

 * @param grfid ID of the grf file

    80

 * @return the ID of the candidate, of the Invalid flag item ID

    81

 */

    82

uint16 OverrideManagerBase::GetID(uint8 grf_local_id, uint32 grfid)

    83

{

    84

	const EntityIDMapping *map;

    85

    86

	for (uint16 id = 0; id < max_new_entities; id++) {

    87

		map = &mapping_ID[id];

    88

		if (map->entity_id == grf_local_id && map->grfid == grfid) {

    89

			return id;

    90

		}

    91

	}

    92

    93

	/* No mapping found, try the overrides */

    94

	for (uint16 id = 0; id < max_offset; id++) {

    95

		if (entity_overrides[id] == grf_local_id && grfid_overrides[id] == grfid) return id;

    96

	}

    97

    98

	return invalid_ID;

    99

}

   100

   101

/** Reserves a place in the mapping array for an entity to be installed

   102

 * @param grf_local_id is an arbitrary id given by the grf's author.  Also known as setid

   103

 * @param grfid is the id of the grf file itself

   104

 * @param substitute_id is the original entity from which data is copied for the new one

   105

 * @return the proper usable slot id, or invalid marker if none is found

   106

 */

   107

uint16 OverrideManagerBase::AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id)

   108

{

   109

	uint16 id = this->GetID(grf_local_id, grfid);

   110

	EntityIDMapping *map;

   111

   112

	/* Look to see if this entity has already been added. This is done

   113

	 * separately from the loop below in case a GRF has been deleted, and there

   114

	 * are any gaps in the array.

   115

	 */

   116

	if (id != invalid_ID) {

   117

		return id;

   118

	}

   119

   120

	/* This entity hasn't been defined before, so give it an ID now. */

   121

	for (id = max_offset; id < max_new_entities; id++) {

   122

		map = &mapping_ID[id];

   123

   124

		if (CheckValidNewID(id) && map->entity_id == 0 && map->grfid == 0) {

   125

			map->entity_id     = grf_local_id;

   126

			map->grfid         = grfid;

   127

			map->substitute_id = substitute_id;

   128

			return id;

   129

		}

   130

	}

   131

   132

	return invalid_ID;

   133

}

   134

   135

/** Gives the substitute of the entity, as specified by the grf file

   136

 * @param entity_id of the entity being queried

   137

 * @return mapped id

   138

 */

   139

uint16 OverrideManagerBase::GetSubstituteID(byte entity_id)

   140

{

   141

	return mapping_ID[entity_id].substitute_id;

   142

}

   143

   144

/** Install the specs into the HouseSpecs array

   145

 * It will find itself the proper slot onwhich it will go

   146

 * @param hs HouseSpec read from the grf file, ready for inclusion

   147

 */

   148

void HouseOverrideManager::SetEntitySpec(const HouseSpec *hs)

   149

{

   150

	HouseID house_id = this->AddEntityID(hs->local_id, hs->grffile->grfid, hs->substitute_id);

   151

   152

	if (house_id == invalid_ID) {

   153

		grfmsg(1, "House.SetEntitySpec: Too many houses allocated. Ignoring.");

   154

		return;

   155

	}

   156

   157

	memcpy(&_house_specs[house_id], hs, sizeof(*hs));

   158

   159

	/* Now add the overrides. */

   160

	for (int i = 0; i != max_offset; i++) {

   161

		HouseSpec *overridden_hs = GetHouseSpecs(i);

   162

   163

		if (entity_overrides[i] != hs->local_id || grfid_overrides[i] != hs->grffile->grfid) continue;

   164

   165

		overridden_hs->override = house_id;

   166

		entity_overrides[i] = invalid_ID;

   167

		grfid_overrides[i] = 0;

   168

	}

   169

}

   170

   171

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

   172

 * @param grf_local_id ID used by the grf file for pre-installation work (equivalent of TTDPatch's setid

   173

 * @param grfid ID of the current grf file

   174

 * @param substitute_id industry from which data has been copied

   175

 * @return a free entity id (slotid) if ever one has been found, or Invalid_ID marker otherwise

   176

 */

   177

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

   178

{

   179

	/* This entity hasn't been defined before, so give it an ID now. */

   180

	for (uint16 id = 0; id < max_new_entities; id++) {

   181

		/* Skip overriden industries */

   182

		if (id < max_offset && entity_overrides[id] != invalid_ID) continue;

   183

   184

		/* Get the real live industry */

   185

		const IndustrySpec *inds = GetIndustrySpec(id);

   186

   187

		/* This industry must be one that is not available(enabled), mostly because of climate.

   188

		 * And it must not already be used by a grf (grffile == NULL).

   189

		 * So reseve this slot here, as it is the chosen one */

   190

		if (!inds->enabled && inds->grf_prop.grffile == NULL) {

   191

			EntityIDMapping *map = &mapping_ID[id];

   192

   193

			if (map->entity_id == 0 && map->grfid == 0) {

   194

				/* winning slot, mark it as been used */

   195

				map->entity_id     = grf_local_id;

   196

				map->grfid         = grfid;

   197

				map->substitute_id = substitute_id;

   198

				return id;

   199

			}

   200

		}

   201

	}

   202

   203

	return invalid_ID;

   204

}

   205

   206

/** Method to install the new indistry data in its proper slot

   207

 * The slot assigment is internal of this method, since it requires

   208

 * checking what is available

   209

 * @param inds Industryspec that comes from the grf decoding process

   210

 */

   211

void IndustryOverrideManager::SetEntitySpec(IndustrySpec *inds)

   212

{

   213

	/* First step : We need to find if this industry is already specified in the savegame data */

   214

	IndustryType ind_id = this->GetID(inds->grf_prop.local_id, inds->grf_prop.grffile->grfid);

   215

   216

	if (ind_id == invalid_ID) {

   217

		/* Not found.

   218

		 * Or it has already been overriden, so you've lost your place old boy.

   219

		 * Or it is a simple substitute.

   220

		 * We need to find a free available slot */

   221

		ind_id = this->AddEntityID(inds->grf_prop.local_id, inds->grf_prop.grffile->grfid, inds->grf_prop.subst_id);

   222

		inds->grf_prop.override = invalid_ID;  // make sure it will not be detected as overriden

   223

	}

   224

   225

	if (ind_id == invalid_ID) {

   226

		grfmsg(1, "Industry.SetEntitySpec: Too many industries allocated. Ignoring.");

   227

		return;

   228

	}

   229

   230

	/* Now that we know we can use the given id, copy the spech to its final destination*/

   231

	memcpy(&_industry_specs[ind_id], inds, sizeof(*inds));

   232

	/* and mark it as usable*/

   233

	_industry_specs[ind_id].enabled = true;

   234

}

   235

   236

void IndustryTileOverrideManager::SetEntitySpec(const IndustryTileSpec *its)

   237

{

   238

	IndustryGfx indt_id = this->AddEntityID(its->grf_prop.local_id, its->grf_prop.grffile->grfid, its->grf_prop.subst_id);

   239

   240

	if (indt_id == invalid_ID) {

   241

		grfmsg(1, "IndustryTile.SetEntitySpec: Too many industry tiles allocated. Ignoring.");

   242

		return;

   243

	}

   244

   245

	memcpy(&_industry_tile_specs[indt_id], its, sizeof(*its));

   246

   247

	/* Now add the overrides. */

   248

	for (int i = 0; i < max_offset; i++) {

   249

		IndustryTileSpec *overridden_its = &_industry_tile_specs[i];

   250

   251

		if (entity_overrides[i] != its->grf_prop.local_id || grfid_overrides[i] != its->grf_prop.grffile->grfid) continue;

   252

   253

		overridden_its->grf_prop.override = indt_id;

   254

		overridden_its->enabled = false;

   255

		entity_overrides[i] = invalid_ID;

   256

		grfid_overrides[i] = 0;

   257

	}

   258

}

   259

   260

/** Function used by houses (and soon industries) to get information

   261

 * on type of "terrain" the tile it is queries sits on.

   262

 * @param tile TileIndex of the tile been queried

   263

 * @return value corresponding to the grf expected format:

   264

 *         Terrain type: 0 normal, 1 desert, 2 rainforest, 4 on or above snowline */

   265

uint32 GetTerrainType(TileIndex tile)

   266

{

   267

	switch (_opt.landscape) {

   268

		case LT_TROPIC: return GetTropicZone(tile) == TROPICZONE_DESERT ? 1 : 2;

   269

		case LT_ARCTIC: return GetTileZ(tile) > GetSnowLine() ? 4 : 0;

   270

		default:        return 0;

   271

	}

   272

}

   273

   274

TileIndex GetNearbyTile(byte parameter, TileIndex tile)

   275

{

   276

	int8 x = GB(parameter, 0, 4);

   277

	int8 y = GB(parameter, 4, 4);

   278

   279

	if (x >= 8) x -= 16;

   280

	if (y >= 8) y -= 16;

   281

   282

	/* Swap width and height depending on axis for railway stations */

   283

	if (IsRailwayStationTile(tile) && GetRailStationAxis(tile) == AXIS_X) Swap(x, y);

   284

   285

	/* Make sure we never roam outside of the map */

   286

	return TILE_MASK(tile + TileDiffXY(x, y));

   287

}