1

/* $Id$ */

     2

     3

/** @file town_map.h Accessors for towns */

     4

     5

#ifndef TOWN_MAP_H

     6

#define TOWN_MAP_H

     7

     8

#include "town.h"

     9

#include "date.h"

    10

    11

/**

    12

 * Get the index of which town this house/street is attached to.

    13

 * @param t the tile

    14

 * @pre IsTileType(t, MP_HOUSE) or IsTileType(t, MP_STREET)

    15

 * @return TownID

    16

 */

    17

static inline TownID GetTownIndex(TileIndex t)

    18

{

    19

	assert(IsTileType(t, MP_HOUSE) || IsTileType(t, MP_STREET)); // XXX incomplete

    20

	return _m[t].m2;

    21

}

    22

    23

/**

    24

 * Set the town index for a road or house tile.

    25

 * @param t the tile

    26

 * @pre IsTileType(t, MP_HOUSE) or IsTileType(t, MP_STREET)

    27

 * @param index the index of the town

    28

 * @pre IsTileType(t, MP_STREET) || IsTileType(t, MP_HOUSE)

    29

 */

    30

static inline void SetTownIndex(TileIndex t, TownID index)

    31

{

    32

	assert(IsTileType(t, MP_HOUSE) || IsTileType(t, MP_STREET));

    33

	_m[t].m2 = index;

    34

}

    35

    36

/**

    37

 * Gets the town associated with the house or road tile

    38

 * @param t the tile to get the town of

    39

 * @return the town

    40

 */

    41

static inline Town* GetTownByTile(TileIndex t)

    42

{

    43

	return GetTown(GetTownIndex(t));

    44

}

    45

    46

/**

    47

 * Get the type of this house, which is an index into the house spec array

    48

 * Since m4 is only a byte and we want to support 512 houses, we use the bit 6

    49

 * of m3 as an additional bit to house type.

    50

 * @param t the tile

    51

 * @pre IsTileType(t, MP_HOUSE)

    52

 * @return house type

    53

 */

    54

static inline HouseID GetHouseType(TileIndex t)

    55

{

    56

	assert(IsTileType(t, MP_HOUSE));

    57

	return _m[t].m4 | (GB(_m[t].m3, 6, 1) << 8);

    58

}

    59

    60

/**

    61

 * Set the house type.

    62

 * @param t the tile

    63

 * @param house_id the new house type

    64

 * @pre IsTileType(t, MP_HOUSE)

    65

 */

    66

static inline void SetHouseType(TileIndex t, HouseID house_id)

    67

{

    68

	assert(IsTileType(t, MP_HOUSE));

    69

	_m[t].m4 = GB(house_id, 0, 8);

    70

	SB(_m[t].m3, 6, 1, GB(house_id, 8, 1));

    71

}

    72

    73

/**

    74

 * Check if the lift of this animated house has a destination

    75

 * @param t the tile

    76

 * @return has destination

    77

 */

    78

static inline bool LiftHasDestination(TileIndex t)

    79

{

    80

	return HASBIT(_me[t].m7, 0);

    81

}

    82

    83

/**

    84

 * Set the new destination of the lift for this animated house, and activate

    85

 * the LiftHasDestination bit.

    86

 * @param t the tile

    87

 * @param dest new destination

    88

 */

    89

static inline void SetLiftDestination(TileIndex t, byte dest)

    90

{

    91

	SETBIT(_me[t].m7, 0);

    92

	SB(_me[t].m7, 1, 3, dest);

    93

}

    94

    95

/**

    96

 * Get the current destination for this lift

    97

 * @param t the tile

    98

 * @return destination

    99

 */

   100

static inline byte GetLiftDestination(TileIndex t)

   101

{

   102

	return GB(_me[t].m7, 1, 3);

   103

}

   104

   105

/**

   106

 * Stop the lift of this animated house from moving.

   107

 * Clears the first 4 bits of m7 at once, clearing the LiftHasDestination bit

   108

 * and the destination.

   109

 * @param t the tile

   110

 */

   111

static inline void HaltLift(TileIndex t)

   112

{

   113

	SB(_me[t].m7, 0, 4, 0);

   114

	DeleteAnimatedTile(t);

   115

}

   116

   117

/**

   118

 * Get the position of the lift on this animated house

   119

 * @param t the tile

   120

 * @return position, from 0 to 36

   121

 */

   122

static inline byte GetLiftPosition(TileIndex t)

   123

{

   124

	return GB(_m[t].m6, 2, 6);

   125

}

   126

   127

/**

   128

 * Set the position of the lift on this animated house

   129

 * @param t the tile

   130

 * @param pos position, from 0 to 36

   131

 */

   132

static inline void SetLiftPosition(TileIndex t, byte pos)

   133

{

   134

	SB(_m[t].m6, 2, 6, pos);

   135

}

   136

   137

/**

   138

 * Get the current animation frame for this house

   139

 * @param t the tile

   140

 * @pre IsTileType(t, MP_HOUSE)

   141

 * @return frame number

   142

 */

   143

static inline byte GetHouseAnimationFrame(TileIndex t)

   144

{

   145

	assert(IsTileType(t, MP_HOUSE));

   146

	return GB(_m[t].m6, 3, 5);

   147

}

   148

   149

/**

   150

 * Set a new animation frame for this house

   151

 * @param t the tile

   152

 * @param frame the new frame number

   153

 * @pre IsTileType(t, MP_HOUSE)

   154

 */

   155

static inline void SetHouseAnimationFrame(TileIndex t, byte frame)

   156

{

   157

	assert(IsTileType(t, MP_HOUSE));

   158

	SB(_m[t].m6, 3, 5, frame);

   159

}

   160

   161

/**

   162

 * Get the completion of this house

   163

 * @param t the tile

   164

 * @return true if it is, false if it is not

   165

 */

   166

static inline bool IsHouseCompleted(TileIndex t)

   167

{

   168

	assert(IsTileType(t, MP_HOUSE));

   169

	return HASBIT(_m[t].m3, 7);

   170

}

   171

   172

/**

   173

 * Mark this house as been completed

   174

 * @param t the tile

   175

 * @param status

   176

 */

   177

static inline void SetHouseCompleted(TileIndex t, bool status)

   178

{

   179

	assert(IsTileType(t, MP_HOUSE));

   180

	SB(_m[t].m3, 7, 1, !!status);

   181

}

   182

   183

/**

   184

 * Make the tile a house.

   185

 * @param t tile index

   186

 * @param tid Town index

   187

 * @param counter of construction step

   188

 * @param stage of construction (used for drawing)

   189

 * @param type of house.  Index into house specs array

   190

 * @param random_bits required for newgrf houses

   191

 * @pre IsTileType(t, MP_CLEAR)

   192

 */

   193

static inline void MakeHouseTile(TileIndex t, TownID tid, byte counter, byte stage, HouseID type, byte random_bits)

   194

{

   195

	assert(IsTileType(t, MP_CLEAR));

   196

   197

	SetTileType(t, MP_HOUSE);

   198

	_m[t].m1 = random_bits;

   199

	_m[t].m2 = tid;

   200

	_m[t].m3 = 0;

   201

	SetHouseType(t, type);

   202

	SetHouseCompleted(t, stage == TOWN_HOUSE_COMPLETED);

   203

	_m[t].m5 = IsHouseCompleted(t) ? 0 : (stage << 3 | counter);

   204

	SetHouseAnimationFrame(t, 0);

   205

	_me[t].m7 = GetHouseSpecs(type)->processing_time;

   206

   207

	if (GetHouseSpecs(type)->building_flags & BUILDING_IS_ANIMATED) AddAnimatedTile(t);

   208

	MarkTileDirtyByTile(t);

   209

}

   210

   211

/**

   212

 * Helper function for MakeHouseTile.

   213

 * It is called  for each tile of a multi-tile house.

   214

 * Parametes are the same.

   215

 * @param t tile index

   216

 * @param tid Town index

   217

 * @param counter of construction step

   218

 * @param stage of construction (used for drawing)

   219

 * @param type of house.  Index into house specs array

   220

 * @param random_bits required for newgrf houses

   221

 */

   222

static inline void MakeTownHouse(TileIndex t, TownID tid, byte counter, byte stage, HouseID type, byte random_bits)

   223

{

   224

	BuildingFlags size = GetHouseSpecs(type)->building_flags;

   225

	MakeHouseTile(t, tid, counter, stage, type, random_bits);

   226

	if (size & BUILDING_2_TILES_Y)   MakeHouseTile(t + TileDiffXY(0, 1), tid, counter, stage, ++type, random_bits);

   227

	if (size & BUILDING_2_TILES_X)   MakeHouseTile(t + TileDiffXY(1, 0), tid, counter, stage, ++type, random_bits);

   228

	if (size & BUILDING_HAS_4_TILES) MakeHouseTile(t + TileDiffXY(1, 1), tid, counter, stage, ++type, random_bits);

   229

}

   230

   231

/**

   232

 * House Construction Scheme.

   233

 *  Construction counter, for buildings under construction. Incremented on every

   234

 *  periodic tile processing.

   235

 *  On wraparound, the stage of building in is increased.

   236

 *  GetHouseBuildingStage is taking care of the real stages,

   237

 *  (as the sprite for the next phase of house building)

   238

 *  (Get|Inc)HouseConstructionTick is simply a tick counter between the

   239

 *  different stages

   240

 */

   241

   242

/**

   243

 * Gets the building stage of a house

   244

 * Since the stage is used for determining what sprite to use,

   245

 * if the house is complete (and that stage no longuer is available),

   246

 * fool the system by returning the TOWN_HOUSE_COMPLETE (3),

   247

 * thus showing a beautiful complete house.

   248

 * @param t the tile of the house to get the building stage of

   249

 * @pre IsTileType(t, MP_HOUSE)

   250

 * @return the building stage of the house

   251

 */

   252

static inline byte GetHouseBuildingStage(TileIndex t)

   253

{

   254

	assert(IsTileType(t, MP_HOUSE));

   255

	return IsHouseCompleted(t) ? (byte)TOWN_HOUSE_COMPLETED : GB(_m[t].m5, 3, 2);

   256

}

   257

   258

/**

   259

 * Gets the construction stage of a house

   260

 * @param t the tile of the house to get the construction stage of

   261

 * @pre IsTileType(t, MP_HOUSE)

   262

 * @return the construction stage of the house

   263

 */

   264

static inline byte GetHouseConstructionTick(TileIndex t)

   265

{

   266

	assert(IsTileType(t, MP_HOUSE));

   267

	return IsHouseCompleted(t) ? 0 : GB(_m[t].m5, 0, 3);

   268

}

   269

   270

/**

   271

 * Sets the increment stage of a house

   272

 * It is working with the whole counter + stage 5 bits, making it

   273

 * easier to work:  the wraparound is automatic.

   274

 * @param t the tile of the house to increment the construction stage of

   275

 * @pre IsTileType(t, MP_HOUSE)

   276

 */

   277

static inline void IncHouseConstructionTick(TileIndex t)

   278

{

   279

	assert(IsTileType(t, MP_HOUSE));

   280

	AB(_m[t].m5, 0, 5, 1);

   281

   282

	if (GB(_m[t].m5, 3, 2) == TOWN_HOUSE_COMPLETED) {

   283

		/* House is now completed.

   284

		 * Store the year of construction as well, for newgrf house purpose */

   285

		SetHouseCompleted(t, true);

   286

		_m[t].m5 = clamp(_cur_year - ORIGINAL_BASE_YEAR, 0, 0xFF);

   287

	}

   288

}

   289

   290

/**

   291

 * Get the year that this house was constructed (between 1920 and 2175).

   292

 * @param t the tile of this house

   293

 * @pre IsTileType(t, MP_HOUSE)

   294

 * @return year

   295

 */

   296

static inline Year GetHouseConstructionYear(TileIndex t)

   297

{

   298

	assert(IsTileType(t, MP_HOUSE));

   299

	return IsHouseCompleted(t) ? _m[t].m5 + ORIGINAL_BASE_YEAR : 0;

   300

}

   301

   302

/**

   303

 * Get the random bits for this house.

   304

 * This is required for newgrf house

   305

 * @param t the tile of this house

   306

 * @pre IsTileType(t, MP_HOUSE)

   307

 * @return random bits

   308

 */

   309

static inline byte GetHouseRandomBits(TileIndex t)

   310

{

   311

	assert(IsTileType(t, MP_HOUSE));

   312

	return _m[t].m1;

   313

}

   314

   315

/**

   316

 * Set the activated triggers bits for this house.

   317

 * This is required for newgrf house

   318

 * @param t        the tile of this house

   319

 * @param triggers the activated triggers

   320

 * @pre IsTileType(t, MP_HOUSE)

   321

 */

   322

static inline void SetHouseTriggers(TileIndex t, byte triggers)

   323

{

   324

	assert(IsTileType(t, MP_HOUSE));

   325

	SB(_m[t].m3, 0, 5, triggers);

   326

}

   327

   328

/**

   329

 * Get the already activated triggers bits for this house.

   330

 * This is required for newgrf house

   331

 * @param t the tile of this house

   332

 * @pre IsTileType(t, MP_HOUSE)

   333

 * @return triggers

   334

 */

   335

static inline byte GetHouseTriggers(TileIndex t)

   336

{

   337

	assert(IsTileType(t, MP_HOUSE));

   338

	return GB(_m[t].m3, 0, 5);

   339

}

   340

   341

/**

   342

 * Get the amount of time remaining before the tile loop processes this tile.

   343

 * @param t the house tile

   344

 * @pre IsTileType(t, MP_HOUSE)

   345

 * @return time remaining

   346

 */

   347

static inline byte GetHouseProcessingTime(TileIndex t)

   348

{

   349

	assert(IsTileType(t, MP_HOUSE));

   350

	return _me[t].m7;

   351

}

   352

   353

/**

   354

 * Set the amount of time remaining before the tile loop processes this tile.

   355

 * @param t the house tile

   356

 * @param time the time to be set

   357

 * @pre IsTileType(t, MP_HOUSE)

   358

 */

   359

static inline void SetHouseProcessingTime(TileIndex t, byte time)

   360

{

   361

	assert(IsTileType(t, MP_HOUSE));

   362

	_me[t].m7 = time;

   363

}

   364

   365

/**

   366

 * Decrease the amount of time remaining before the tile loop processes this tile.

   367

 * @param t the house tile

   368

 * @pre IsTileType(t, MP_HOUSE)

   369

 */

   370

static inline void DecHouseProcessingTime(TileIndex t)

   371

{

   372

	assert(IsTileType(t, MP_HOUSE));

   373

	_me[t].m7--;

   374

}

   375

   376

#endif /* TOWN_MAP_H */