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_func.h"

    10

#include "tile_map.h"

    11

#include "functions.h"

    12

    13

/**

    14

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

    15

 * @param t the tile

    16

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

    17

 * @return TownID

    18

 */

    19

static inline TownID GetTownIndex(TileIndex t)

    20

{

    21

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

    22

	return _m[t].m2;

    23

}

    24

    25

/**

    26

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

    27

 * @param t the tile

    28

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

    29

 * @param index the index of the town

    30

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

    31

 */

    32

static inline void SetTownIndex(TileIndex t, TownID index)

    33

{

    34

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

    35

	_m[t].m2 = index;

    36

}

    37

    38

/**

    39

 * Gets the town associated with the house or road tile

    40

 * @param t the tile to get the town of

    41

 * @return the town

    42

 */

    43

static inline Town *GetTownByTile(TileIndex t)

    44

{

    45

	return GetTown(GetTownIndex(t));

    46

}

    47

    48

/**

    49

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

    50

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

    51

 * of m3 as an additional bit to house type.

    52

 * @param t the tile

    53

 * @pre IsTileType(t, MP_HOUSE)

    54

 * @return house type

    55

 */

    56

static inline HouseID GetHouseType(TileIndex t)

    57

{

    58

	assert(IsTileType(t, MP_HOUSE));

    59

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

    60

}

    61

    62

/**

    63

 * Set the house type.

    64

 * @param t the tile

    65

 * @param house_id the new house type

    66

 * @pre IsTileType(t, MP_HOUSE)

    67

 */

    68

static inline void SetHouseType(TileIndex t, HouseID house_id)

    69

{

    70

	assert(IsTileType(t, MP_HOUSE));

    71

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

    72

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

    73

}

    74

    75

/**

    76

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

    77

 * @param t the tile

    78

 * @return has destination

    79

 */

    80

static inline bool LiftHasDestination(TileIndex t)

    81

{

    82

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

    83

}

    84

    85

/**

    86

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

    87

 * the LiftHasDestination bit.

    88

 * @param t the tile

    89

 * @param dest new destination

    90

 */

    91

static inline void SetLiftDestination(TileIndex t, byte dest)

    92

{

    93

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

    94

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

    95

}

    96

    97

/**

    98

 * Get the current destination for this lift

    99

 * @param t the tile

   100

 * @return destination

   101

 */

   102

static inline byte GetLiftDestination(TileIndex t)

   103

{

   104

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

   105

}

   106

   107

/**

   108

 * Stop the lift of this animated house from moving.

   109

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

   110

 * and the destination.

   111

 * @param t the tile

   112

 */

   113

static inline void HaltLift(TileIndex t)

   114

{

   115

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

   116

	DeleteAnimatedTile(t);

   117

}

   118

   119

/**

   120

 * Get the position of the lift on this animated house

   121

 * @param t the tile

   122

 * @return position, from 0 to 36

   123

 */

   124

static inline byte GetLiftPosition(TileIndex t)

   125

{

   126

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

   127

}

   128

   129

/**

   130

 * Set the position of the lift on this animated house

   131

 * @param t the tile

   132

 * @param pos position, from 0 to 36

   133

 */

   134

static inline void SetLiftPosition(TileIndex t, byte pos)

   135

{

   136

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

   137

}

   138

   139

/**

   140

 * Get the current animation frame for this house

   141

 * @param t the tile

   142

 * @pre IsTileType(t, MP_HOUSE)

   143

 * @return frame number

   144

 */

   145

static inline byte GetHouseAnimationFrame(TileIndex t)

   146

{

   147

	assert(IsTileType(t, MP_HOUSE));

   148

	return GB(_m[t].m6, 2, 6) | (GB(_m[t].m3, 5, 1) << 6);

   149

}

   150

   151

/**

   152

 * Set a new animation frame for this house

   153

 * @param t the tile

   154

 * @param frame the new frame number

   155

 * @pre IsTileType(t, MP_HOUSE)

   156

 */

   157

static inline void SetHouseAnimationFrame(TileIndex t, byte frame)

   158

{

   159

	assert(IsTileType(t, MP_HOUSE));

   160

	SB(_m[t].m6, 2, 6, GB(frame, 0, 6));

   161

	SB(_m[t].m3, 5, 1, GB(frame, 6, 1));

   162

}

   163

   164

/**

   165

 * Get the completion of this house

   166

 * @param t the tile

   167

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

   168

 */

   169

static inline bool IsHouseCompleted(TileIndex t)

   170

{

   171

	assert(IsTileType(t, MP_HOUSE));

   172

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

   173

}

   174

   175

/**

   176

 * Mark this house as been completed

   177

 * @param t the tile

   178

 * @param status

   179

 */

   180

static inline void SetHouseCompleted(TileIndex t, bool status)

   181

{

   182

	assert(IsTileType(t, MP_HOUSE));

   183

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

   184

}

   185

   186

/**

   187

 * Make the tile a house.

   188

 * @param t tile index

   189

 * @param tid Town index

   190

 * @param counter of construction step

   191

 * @param stage of construction (used for drawing)

   192

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

   193

 * @param random_bits required for newgrf houses

   194

 * @pre IsTileType(t, MP_CLEAR)

   195

 */

   196

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

   197

{

   198

	assert(IsTileType(t, MP_CLEAR));

   199

   200

	SetTileType(t, MP_HOUSE);

   201

	_m[t].m1 = random_bits;

   202

	_m[t].m2 = tid;

   203

	_m[t].m3 = 0;

   204

	SetHouseType(t, type);

   205

	SetHouseCompleted(t, stage == TOWN_HOUSE_COMPLETED);

   206

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

   207

	SetHouseAnimationFrame(t, 0);

   208

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

   209

   210

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

   211

	MarkTileDirtyByTile(t);

   212

}

   213

   214

/**

   215

 * House Construction Scheme.

   216

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

   217

 *  periodic tile processing.

   218

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

   219

 *  GetHouseBuildingStage is taking care of the real stages,

   220

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

   221

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

   222

 *  different stages

   223

 */

   224

   225

/**

   226

 * Gets the building stage of a house

   227

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

   228

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

   229

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

   230

 * thus showing a beautiful complete house.

   231

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

   232

 * @pre IsTileType(t, MP_HOUSE)

   233

 * @return the building stage of the house

   234

 */

   235

static inline byte GetHouseBuildingStage(TileIndex t)

   236

{

   237

	assert(IsTileType(t, MP_HOUSE));

   238

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

   239

}

   240

   241

/**

   242

 * Gets the construction stage of a house

   243

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

   244

 * @pre IsTileType(t, MP_HOUSE)

   245

 * @return the construction stage of the house

   246

 */

   247

static inline byte GetHouseConstructionTick(TileIndex t)

   248

{

   249

	assert(IsTileType(t, MP_HOUSE));

   250

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

   251

}

   252

   253

/**

   254

 * Sets the increment stage of a house

   255

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

   256

 * easier to work:  the wraparound is automatic.

   257

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

   258

 * @pre IsTileType(t, MP_HOUSE)

   259

 */

   260

static inline void IncHouseConstructionTick(TileIndex t)

   261

{

   262

	assert(IsTileType(t, MP_HOUSE));

   263

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

   264

   265

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

   266

		/* House is now completed.

   267

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

   268

		SetHouseCompleted(t, true);

   269

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

   270

	}

   271

}

   272

   273

/**

   274

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

   275

 * @param t the tile of this house

   276

 * @pre IsTileType(t, MP_HOUSE)

   277

 * @return year

   278

 */

   279

static inline Year GetHouseConstructionYear(TileIndex t)

   280

{

   281

	assert(IsTileType(t, MP_HOUSE));

   282

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

   283

}

   284

   285

/**

   286

 * Set the random bits for this house.

   287

 * This is required for newgrf house

   288

 * @param t      the tile of this house

   289

 * @param random the new random bits

   290

 * @pre IsTileType(t, MP_HOUSE)

   291

 */

   292

static inline void SetHouseRandomBits(TileIndex t, byte random)

   293

{

   294

	assert(IsTileType(t, MP_HOUSE));

   295

	_m[t].m1 = random;

   296

}

   297

   298

/**

   299

 * Get the random bits for this house.

   300

 * This is required for newgrf house

   301

 * @param t the tile of this house

   302

 * @pre IsTileType(t, MP_HOUSE)

   303

 * @return random bits

   304

 */

   305

static inline byte GetHouseRandomBits(TileIndex t)

   306

{

   307

	assert(IsTileType(t, MP_HOUSE));

   308

	return _m[t].m1;

   309

}

   310

   311

/**

   312

 * Set the activated triggers bits for this house.

   313

 * This is required for newgrf house

   314

 * @param t        the tile of this house

   315

 * @param triggers the activated triggers

   316

 * @pre IsTileType(t, MP_HOUSE)

   317

 */

   318

static inline void SetHouseTriggers(TileIndex t, byte triggers)

   319

{

   320

	assert(IsTileType(t, MP_HOUSE));

   321

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

   322

}

   323

   324

/**

   325

 * Get the already activated triggers bits for this house.

   326

 * This is required for newgrf house

   327

 * @param t the tile of this house

   328

 * @pre IsTileType(t, MP_HOUSE)

   329

 * @return triggers

   330

 */

   331

static inline byte GetHouseTriggers(TileIndex t)

   332

{

   333

	assert(IsTileType(t, MP_HOUSE));

   334

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

   335

}

   336

   337

/**

   338

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

   339

 * @param t the house tile

   340

 * @pre IsTileType(t, MP_HOUSE)

   341

 * @return time remaining

   342

 */

   343

static inline byte GetHouseProcessingTime(TileIndex t)

   344

{

   345

	assert(IsTileType(t, MP_HOUSE));

   346

	return _me[t].m7;

   347

}

   348

   349

/**

   350

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

   351

 * @param t the house tile

   352

 * @param time the time to be set

   353

 * @pre IsTileType(t, MP_HOUSE)

   354

 */

   355

static inline void SetHouseProcessingTime(TileIndex t, byte time)

   356

{

   357

	assert(IsTileType(t, MP_HOUSE));

   358

	_me[t].m7 = time;

   359

}

   360

   361

/**

   362

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

   363

 * @param t the house tile

   364

 * @pre IsTileType(t, MP_HOUSE)

   365

 */

   366

static inline void DecHouseProcessingTime(TileIndex t)

   367

{

   368

	assert(IsTileType(t, MP_HOUSE));

   369

	_me[t].m7--;

   370

}

   371

   372

#endif /* TOWN_MAP_H */