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"

    11

#include "tile_map.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

}

   117

   118

/**

   119

 * Get the position of the lift on this animated house

   120

 * @param t the tile

   121

 * @return position, from 0 to 36

   122

 */

   123

static inline byte GetLiftPosition(TileIndex t)

   124

{

   125

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

   126

}

   127

   128

/**

   129

 * Set the position of the lift on this animated house

   130

 * @param t the tile

   131

 * @param pos position, from 0 to 36

   132

 */

   133

static inline void SetLiftPosition(TileIndex t, byte pos)

   134

{

   135

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

   136

}

   137

   138

/**

   139

 * Get the current animation frame for this house

   140

 * @param t the tile

   141

 * @pre IsTileType(t, MP_HOUSE)

   142

 * @return frame number

   143

 */

   144

static inline byte GetHouseAnimationFrame(TileIndex t)

   145

{

   146

	assert(IsTileType(t, MP_HOUSE));

   147

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

   148

}

   149

   150

/**

   151

 * Set a new animation frame for this house

   152

 * @param t the tile

   153

 * @param frame the new frame number

   154

 * @pre IsTileType(t, MP_HOUSE)

   155

 */

   156

static inline void SetHouseAnimationFrame(TileIndex t, byte frame)

   157

{

   158

	assert(IsTileType(t, MP_HOUSE));

   159

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

   160

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

   161

}

   162

   163

/**

   164

 * Get the completion of this house

   165

 * @param t the tile

   166

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

   167

 */

   168

static inline bool IsHouseCompleted(TileIndex t)

   169

{

   170

	assert(IsTileType(t, MP_HOUSE));

   171

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

   172

}

   173

   174

/**

   175

 * Mark this house as been completed

   176

 * @param t the tile

   177

 * @param status

   178

 */

   179

static inline void SetHouseCompleted(TileIndex t, bool status)

   180

{

   181

	assert(IsTileType(t, MP_HOUSE));

   182

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

   183

}

   184

   185

/**

   186

 * Make the tile a house.

   187

 * @param t tile index

   188

 * @param tid Town index

   189

 * @param counter of construction step

   190

 * @param stage of construction (used for drawing)

   191

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

   192

 * @param random_bits required for newgrf houses

   193

 * @pre IsTileType(t, MP_CLEAR)

   194

 */

   195

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

   196

{

   197

	assert(IsTileType(t, MP_CLEAR));

   198

   199

	SetTileType(t, MP_HOUSE);

   200

	_m[t].m1 = random_bits;

   201

	_m[t].m2 = tid;

   202

	_m[t].m3 = 0;

   203

	SetHouseType(t, type);

   204

	SetHouseCompleted(t, stage == TOWN_HOUSE_COMPLETED);

   205

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

   206

	SetHouseAnimationFrame(t, 0);

   207

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

   208

}

   209

   210

/**

   211

 * House Construction Scheme.

   212

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

   213

 *  periodic tile processing.

   214

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

   215

 *  GetHouseBuildingStage is taking care of the real stages,

   216

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

   217

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

   218

 *  different stages

   219

 */

   220

   221

/**

   222

 * Gets the building stage of a house

   223

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

   224

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

   225

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

   226

 * thus showing a beautiful complete house.

   227

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

   228

 * @pre IsTileType(t, MP_HOUSE)

   229

 * @return the building stage of the house

   230

 */

   231

static inline byte GetHouseBuildingStage(TileIndex t)

   232

{

   233

	assert(IsTileType(t, MP_HOUSE));

   234

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

   235

}

   236

   237

/**

   238

 * Gets the construction stage of a house

   239

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

   240

 * @pre IsTileType(t, MP_HOUSE)

   241

 * @return the construction stage of the house

   242

 */

   243

static inline byte GetHouseConstructionTick(TileIndex t)

   244

{

   245

	assert(IsTileType(t, MP_HOUSE));

   246

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

   247

}

   248

   249

/**

   250

 * Sets the increment stage of a house

   251

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

   252

 * easier to work:  the wraparound is automatic.

   253

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

   254

 * @pre IsTileType(t, MP_HOUSE)

   255

 */

   256

static inline void IncHouseConstructionTick(TileIndex t)

   257

{

   258

	assert(IsTileType(t, MP_HOUSE));

   259

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

   260

   261

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

   262

		/* House is now completed.

   263

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

   264

		SetHouseCompleted(t, true);

   265

	}

   266

}

   267

   268

/**

   269

 * Set the year that this house was constructed.

   270

 * @param t the tile of this house

   271

 * @param year the year to set

   272

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

   273

 */

   274

static inline void SetHouseConstructionYear(TileIndex t, Year year)

   275

{

   276

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

   277

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

   278

}

   279

   280

/**

   281

 * Get the year that this house was constructed.

   282

 * @param t the tile of this house

   283

 * @pre IsTileType(t, MP_HOUSE)

   284

 * @return year

   285

 */

   286

static inline Year GetHouseConstructionYear(TileIndex t)

   287

{

   288

	assert(IsTileType(t, MP_HOUSE));

   290

}

   291

   292

/**

   293

 * Set the random bits for this house.

   294

 * This is required for newgrf house

   295

 * @param t      the tile of this house

   296

 * @param random the new random bits

   297

 * @pre IsTileType(t, MP_HOUSE)

   298

 */

   299

static inline void SetHouseRandomBits(TileIndex t, byte random)

   300

{

   301

	assert(IsTileType(t, MP_HOUSE));

   302

	_m[t].m1 = random;

   303

}

   304

   305

/**

   306

 * Get the random bits for this house.

   307

 * This is required for newgrf house

   308

 * @param t the tile of this house

   309

 * @pre IsTileType(t, MP_HOUSE)

   310

 * @return random bits

   311

 */

   312

static inline byte GetHouseRandomBits(TileIndex t)

   313

{

   314

	assert(IsTileType(t, MP_HOUSE));

   315

	return _m[t].m1;

   316

}

   317

   318

/**

   319

 * Set the activated triggers bits for this house.

   320

 * This is required for newgrf house

   321

 * @param t        the tile of this house

   322

 * @param triggers the activated triggers

   323

 * @pre IsTileType(t, MP_HOUSE)

   324

 */

   325

static inline void SetHouseTriggers(TileIndex t, byte triggers)

   326

{

   327

	assert(IsTileType(t, MP_HOUSE));

   328

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

   329

}

   330

   331

/**

   332

 * Get the already activated triggers bits for this house.

   333

 * This is required for newgrf house

   334

 * @param t the tile of this house

   335

 * @pre IsTileType(t, MP_HOUSE)

   336

 * @return triggers

   337

 */

   338

static inline byte GetHouseTriggers(TileIndex t)

   339

{

   340

	assert(IsTileType(t, MP_HOUSE));

   341

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

   342

}

   343

   344

/**

   345

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

   346

 * @param t the house tile

   347

 * @pre IsTileType(t, MP_HOUSE)

   348

 * @return time remaining

   349

 */

   350

static inline byte GetHouseProcessingTime(TileIndex t)

   351

{

   352

	assert(IsTileType(t, MP_HOUSE));

   353

	return _me[t].m7;

   354

}

   355

   356

/**

   357

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

   358

 * @param t the house tile

   359

 * @param time the time to be set

   360

 * @pre IsTileType(t, MP_HOUSE)

   361

 */

   362

static inline void SetHouseProcessingTime(TileIndex t, byte time)

   363

{

   364

	assert(IsTileType(t, MP_HOUSE));

   365

	_me[t].m7 = time;

   366

}

   367

   368

/**

   369

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

   370

 * @param t the house tile

   371

 * @pre IsTileType(t, MP_HOUSE)

   372

 */

   373

static inline void DecHouseProcessingTime(TileIndex t)

   374

{

   375

	assert(IsTileType(t, MP_HOUSE));

   376

	_me[t].m7--;

   377

}

   378

   379

#endif /* TOWN_MAP_H */