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

    16

/** Constructor of generic class

    17

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

    18

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

    19

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

    20

 */

    21

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

    22

{

    23

	max_offset = offset;

    24

	max_new_entities = maximum;

    25

	invalid_ID = invalid;

    26

    27

	mapping_ID = CallocT<EntityIDMapping>(max_new_entities);

    28

	entity_overrides = MallocT<uint16>(max_offset);

    29

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

    30

	grfid_overrides = CallocT<uint32>(max_offset);

    31

}

    32

    33

/** Destructor of the generic class.

    34

 * Frees allocated memory of constructor

    35

 */

    36

OverrideManagerBase::~OverrideManagerBase()

    37

{

    38

	free(mapping_ID);

    39

	free(entity_overrides);

    40

	free(grfid_overrides);

    41

}

    42

    43

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

    44

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

    45

 * translated when the entity spec is set.

    46

 * @param local_id ID in grf file

    47

 * @param grfid  ID of the grf file

    48

 * @param entity_type original entity type

    49

 */

    50

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

    51

{

    52

	assert(entity_type < max_offset);

    53

	/* An override can be set only once */

    54

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

    55

	entity_overrides[entity_type] = local_id;

    56

	grfid_overrides[entity_type] = grfid;

    57

}

    58

    59

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

    60

void OverrideManagerBase::ResetMapping()

    61

{

    62

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

    63

}

    64

    65

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

    66

void OverrideManagerBase::ResetOverride()

    67

{

    68

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

    69

		entity_overrides[i] = invalid_ID;

    70

		grfid_overrides[i] = 0;

    71

	}

    72

}

    73

    74

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

    75

 * @param grf_local_id ID of this enity withing the grfID

    76

 * @param grfid ID of the grf file

    77

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

    78

 */

    79

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

    80

{

    81

	const EntityIDMapping *map;

    82

    83

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

    84

		map = &mapping_ID[id];

    85

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

    86

			return id;

    87

		}

    88

	}

    89

    90

	/* No mapping found, try the overrides */

    91

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

    92

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

    93

	}

    94

    95

	return invalid_ID;

    96

}

    97

    98

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

    99

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

   100

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

   101

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

   102

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

   103

 */

   104

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

   105

{

   106

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

   107

	EntityIDMapping *map;

   108

   109

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

   110

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

   111

	 * are any gaps in the array.

   112

	 */

   113

	if (id != invalid_ID) {

   114

		return id;

   115

	}

   116

   117

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

   118

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

   119

		map = &mapping_ID[id];

   120

   121

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

   122

			map->entity_id     = grf_local_id;

   123

			map->grfid         = grfid;

   124

			map->substitute_id = substitute_id;

   125

			return id;

   126

		}

   127

	}

   128

   129

	return invalid_ID;

   130

}

   131

   132

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

   133

 * @param entity_id of the entity being queried

   134

 * @return mapped id

   135

 */

   136

uint16 OverrideManagerBase::GetSubstituteID(byte entity_id)

   137

{

   138

	return mapping_ID[entity_id].substitute_id;

   139

}

   140

   141

/** Install the specs into the HouseSpecs array

   142

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

   143

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

   144

 */

   145

void HouseOverrideManager::SetEntitySpec(const HouseSpec *hs)

   146

{

   147

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

   148

   149

	if (house_id == invalid_ID) {

   150

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

   151

		return;

   152

	}

   153

   154

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

   155

   156

	/* Now add the overrides. */

   157

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

   158

		HouseSpec *overridden_hs = GetHouseSpecs(i);

   159

   160

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

   161

   162

		overridden_hs->override = house_id;

   163

		entity_overrides[i] = invalid_ID;

   164

		grfid_overrides[i] = 0;

   165

	}

   166

}

   167

   168

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

   169

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

   170

 * @param grfid ID of the current grf file

   171

 * @param substitute_id industry from which data has been copied

   172

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

   173

 */

   174

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

   175

{

   176

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

   177

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

   178

		/* Skip overriden industries */

   179

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

   180

   181

		/* Get the real live industry */

   182

		const IndustrySpec *inds = GetIndustrySpec(id);

   183

   184

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

   185

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

   186

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

   187

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

   188

			EntityIDMapping *map = &mapping_ID[id];

   189

   190

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

   191

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

   192

				map->entity_id     = grf_local_id;

   193

				map->grfid         = grfid;

   194

				map->substitute_id = substitute_id;

   195

				return id;

   196

			}

   197

		}

   198

	}

   199

   200

	return invalid_ID;

   201

}

   202

   203

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

   204

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

   205

 * checking what is available

   206

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

   207

 */

   208

void IndustryOverrideManager::SetEntitySpec(IndustrySpec *inds)

   209

{

   210

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

   211

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

   212

   213

	if (ind_id == invalid_ID) {

   214

		/* Not found.

   215

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

   216

		 * Or it is a simple substitute.

   217

		 * We need to find a free available slot */

   218

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

   219

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

   220

	}

   221

   222

	if (ind_id == invalid_ID) {

   223

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

   224

		return;

   225

	}

   226

   227

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

   228

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

   229

	/* and mark it as usable*/

   230

	_industry_specs[ind_id].enabled = true;

   231

}

   232

   233

void IndustryTileOverrideManager::SetEntitySpec(const IndustryTileSpec *its)

   234

{

   235

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

   236

   237

	if (indt_id == invalid_ID) {

   238

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

   239

		return;

   240

	}

   241

   242

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

   243

   244

	/* Now add the overrides. */

   245

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

   246

		IndustryTileSpec *overridden_its = &_industry_tile_specs[i];

   247

   248

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

   249

   250

		overridden_its->grf_prop.override = indt_id;

   251

		overridden_its->enabled = false;

   252

		entity_overrides[i] = invalid_ID;

   253

		grfid_overrides[i] = 0;

   254

	}

   255

}

   256

   257

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

   258

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

   259

 * @param tile TileIndex of the tile been queried

   260

 * @return value corresponding to the grf expected format:

   261

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

   262

uint32 GetTerrainType(TileIndex tile)

   263

{

   264

	switch (_opt.landscape) {

   265

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

   266

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

   267

		default:        return 0;

   268

	}

   269

}

   270

   271

TileIndex GetNearbyTile(byte parameter, TileIndex tile)

   272

{

   273

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

   274

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

   275

   276

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

   277

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

   278

   279

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

   280

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

   281

}