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

    10

#include "tile_map.h"

    11

    12

/**

    13

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

    14

 * @param t the tile

    15

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

    16

 * @return TownID

    17

 */

    18

static inline TownID GetTownIndex(TileIndex t)

    19

{

    20

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

    21

	return _m[t].m2;

    22

}

    23

    24

/**

    25

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

    26

 * @param t the tile

    27

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

    28

 * @param index the index of the town

    29

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

    30

 */

    31

static inline void SetTownIndex(TileIndex t, TownID index)

    32

{

    33

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

    34

	_m[t].m2 = index;

    35

}

    36

    37

/**

    38

 * Gets the town associated with the house or road tile

    39

 * @param t the tile to get the town of

    40

 * @return the town

    41

 */

    42

static inline Town *GetTownByTile(TileIndex t)

    43

{

    44

	return GetTown(GetTownIndex(t));

    45

}

    46

    47

/**

    48

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

    49

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

    50

 * of m3 as an additional bit to house type.

    51

 * @param t the tile

    52

 * @pre IsTileType(t, MP_HOUSE)

    53

 * @return house type

    54

 */

    55

static inline HouseID GetHouseType(TileIndex t)

    56

{

    57

	assert(IsTileType(t, MP_HOUSE));

    58

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

    59

}

    60

    61

/**

    62

 * Set the house type.

    63

 * @param t the tile

    64

 * @param house_id the new house type

    65

 * @pre IsTileType(t, MP_HOUSE)

    66

 */

    67

static inline void SetHouseType(TileIndex t, HouseID house_id)

    68

{

    69

	assert(IsTileType(t, MP_HOUSE));

    70

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

    71

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

    72

}

    73

    74

/**

    75

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

    76

 * @param t the tile

    77

 * @return has destination

    78

 */

    79

static inline bool LiftHasDestination(TileIndex t)

    80

{

    81

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

    82

}

    83

    84

/**

    85

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

    86

 * the LiftHasDestination bit.

    87

 * @param t the tile

    88

 * @param dest new destination

    89

 */

    90

static inline void SetLiftDestination(TileIndex t, byte dest)

    91

{

    92

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

    93

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

    94

}

    95

    96

/**

    97

 * Get the current destination for this lift

    98

 * @param t the tile

    99

 * @return destination

   100

 */

   101

static inline byte GetLiftDestination(TileIndex t)

   102

{

   103

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

   104

}

   105

   106

/**

   107

 * Stop the lift of this animated house from moving.

   108

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

   109

 * and the destination.

   110

 * @param t the tile

   111

 */

   112

static inline void HaltLift(TileIndex t)

   113

{

   114

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

   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, 2, 6) | (GB(_m[t].m3, 5, 1) << 6);

   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, 2, 6, GB(frame, 0, 6));

   159

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

   160

}

   161

   162

/**

   163

 * Get the completion of this house

   164

 * @param t the tile

   165

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

   166

 */

   167

static inline bool IsHouseCompleted(TileIndex t)

   168

{

   169

	assert(IsTileType(t, MP_HOUSE));

   170

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

   171

}

   172

   173

/**

   174

 * Mark this house as been completed

   175

 * @param t the tile

   176

 * @param status

   177

 */

   178

static inline void SetHouseCompleted(TileIndex t, bool status)

   179

{

   180

	assert(IsTileType(t, MP_HOUSE));

   181

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

   182

}

   183

   184

/**

   185

 * Make the tile a house.

   186

 * @param t tile index

   187

 * @param tid Town index

   188

 * @param counter of construction step

   189

 * @param stage of construction (used for drawing)

   190

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

   191

 * @param random_bits required for newgrf houses

   192

 * @pre IsTileType(t, MP_CLEAR)

   193

 */

   194

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

   195

{

   196

	assert(IsTileType(t, MP_CLEAR));

   197

   198

	SetTileType(t, MP_HOUSE);

   199

	_m[t].m1 = random_bits;

   200

	_m[t].m2 = tid;

   201

	_m[t].m3 = 0;

   202

	SetHouseType(t, type);

   203

	SetHouseCompleted(t, stage == TOWN_HOUSE_COMPLETED);

   204

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

   205

	SetHouseAnimationFrame(t, 0);

   206

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

   207

}

   208

   209

/**

   210

 * House Construction Scheme.

   211

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

   212

 *  periodic tile processing.

   213

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

   214

 *  GetHouseBuildingStage is taking care of the real stages,

   215

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

   216

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

   217

 *  different stages

   218

 */

   219

   220

/**

   221

 * Gets the building stage of a house

   222

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

   223

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

   224

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

   225

 * thus showing a beautiful complete house.

   226

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

   227

 * @pre IsTileType(t, MP_HOUSE)

   228

 * @return the building stage of the house

   229

 */

   230

static inline byte GetHouseBuildingStage(TileIndex t)

   231

{

   232

	assert(IsTileType(t, MP_HOUSE));

   233

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

   234

}

   235

   236

/**

   237

 * Gets the construction stage of a house

   238

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

   239

 * @pre IsTileType(t, MP_HOUSE)

   240

 * @return the construction stage of the house

   241

 */

   242

static inline byte GetHouseConstructionTick(TileIndex t)

   243

{

   244

	assert(IsTileType(t, MP_HOUSE));

   245

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

   246

}

   247

   248

/**

   249

 * Sets the increment stage of a house

   250

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

   251

 * easier to work:  the wraparound is automatic.

   252

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

   253

 * @pre IsTileType(t, MP_HOUSE)

   254

 */

   255

static inline void IncHouseConstructionTick(TileIndex t)

   256

{

   257

	assert(IsTileType(t, MP_HOUSE));

   258

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

   259

   260

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

   261

		/* House is now completed.

   262

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

   263

		SetHouseCompleted(t, true);

   264

	}

   265

}

   266

   267

/**

   268

 * Set the year that this house was constructed.

   269

 * @param t the tile of this house

   270

 * @param year the year to set

   271

 * @pre IsTileType(t, MP_HOUSE) && IsHouseCompleted(t)

   272

 */

   273

static inline void SetHouseConstructionYear(TileIndex t, Year year)

   274

{

   275

	assert(IsTileType(t, MP_HOUSE) && IsHouseCompleted(t));

   276

	_m[t].m5 = Clamp(year - GetHouseSpecs(GetHouseType(t))->min_year, 0, 0xFF);

   277

}

   278

   279

/**

   280

 * Get the year that this house was constructed.

   281

 * @param t the tile of this house

   282

 * @pre IsTileType(t, MP_HOUSE)

   283

 * @return year

   284

 */

   285

static inline Year GetHouseConstructionYear(TileIndex t)

   286

{

   287

	assert(IsTileType(t, MP_HOUSE));

   288

	return IsHouseCompleted(t) ? _m[t].m5 + GetHouseSpecs(GetHouseType(t))->min_year : 0;

   289

}

   290

   291

/**

   292

 * Set the random bits for this house.

   293

 * This is required for newgrf house

   294

 * @param t      the tile of this house

   295

 * @param random the new random bits

   296

 * @pre IsTileType(t, MP_HOUSE)

   297

 */

   298

static inline void SetHouseRandomBits(TileIndex t, byte random)

   299

{

   300

	assert(IsTileType(t, MP_HOUSE));

   301

	_m[t].m1 = random;

   302

}

   303

   304

/**

   305

 * Get the random bits for this house.

   306

 * This is required for newgrf house

   307

 * @param t the tile of this house

   308

 * @pre IsTileType(t, MP_HOUSE)

   309

 * @return random bits

   310

 */

   311

static inline byte GetHouseRandomBits(TileIndex t)

   312

{

   313

	assert(IsTileType(t, MP_HOUSE));

   314

	return _m[t].m1;

   315

}

   316

   317

/**

   318

 * Set the activated triggers bits for this house.

   319

 * This is required for newgrf house

   320

 * @param t        the tile of this house

   321

 * @param triggers the activated triggers

   322

 * @pre IsTileType(t, MP_HOUSE)

   323

 */

   324

static inline void SetHouseTriggers(TileIndex t, byte triggers)

   325

{

   326

	assert(IsTileType(t, MP_HOUSE));

   327

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

   328

}

   329

   330

/**

   331

 * Get the already activated triggers bits for this house.

   332

 * This is required for newgrf house

   333

 * @param t the tile of this house

   334

 * @pre IsTileType(t, MP_HOUSE)

   335

 * @return triggers

   336

 */

   337

static inline byte GetHouseTriggers(TileIndex t)

   338

{

   339

	assert(IsTileType(t, MP_HOUSE));

   340

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

   341

}

   342

   343

/**

   344

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

   345

 * @param t the house tile

   346

 * @pre IsTileType(t, MP_HOUSE)

   347

 * @return time remaining

   348

 */

   349

static inline byte GetHouseProcessingTime(TileIndex t)

   350

{

   351

	assert(IsTileType(t, MP_HOUSE));

   352

	return _me[t].m7;

   353

}

   354

   355

/**

   356

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

   357

 * @param t the house tile

   358

 * @param time the time to be set

   359

 * @pre IsTileType(t, MP_HOUSE)

   360

 */

   361

static inline void SetHouseProcessingTime(TileIndex t, byte time)

   362

{

   363

	assert(IsTileType(t, MP_HOUSE));

   364

	_me[t].m7 = time;

   365

}

   366

   367

/**

   368

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

   369

 * @param t the house tile

   370

 * @pre IsTileType(t, MP_HOUSE)

   371

 */

   372

static inline void DecHouseProcessingTime(TileIndex t)

   373

{

   374

	assert(IsTileType(t, MP_HOUSE));

   375

	_me[t].m7--;

   376

}

   377

   378

#endif /* TOWN_MAP_H */