1

/* $Id$ */

     2

     3

/** @file unmovable_map.h Map accessors for unmovable tiles. */

     4

     5

#ifndef UNMOVABLE_MAP_H

     6

#define UNMOVABLE_MAP_H

     7

     8

#include "core/bitmath_func.hpp"

     9

#include "tile_map.h"

    10

    11

enum {

    12

	HQ_NUM_TILE = 4, ///< Number of HQ tiles

    13

	HQ_NUM_SIZE = 5  ///< Number of stages of an HQ

    14

};

    15

    16

/** Types of unmovable structure */

    17

enum UnmovableType {

    18

	UNMOVABLE_TRANSMITTER = 0,    ///< The large antenna

    19

	UNMOVABLE_LIGHTHOUSE  = 1,    ///< The nice lighthouse

    20

	UNMOVABLE_STATUE      = 2,    ///< Statue in towns

    21

	UNMOVABLE_OWNED_LAND  = 3,    ///< Owned land 'flag'

    22

	UNMOVABLE_HQ_NORTH    = 0x80, ///< Offset for the northern HQ tile

    23

	UNMOVABLE_HQ_WEST     = 0x81, ///< Offset for the western HQ tile

    24

	UNMOVABLE_HQ_EAST     = 0x82, ///< Offset for the eastern HQ tile

    25

	UNMOVABLE_HQ_SOUTH    = 0x83, ///< Offset for the southern HQ tile

    26

    27

	/** End of the HQ (rather end + 1 for IsInside) */

    28

	UNMOVABLE_HQ_END      = UNMOVABLE_HQ_NORTH + HQ_NUM_SIZE * HQ_NUM_TILE

    29

};

    30

    31

    32

    33

/**

    34

 * Gets the UnmovableType of the given unmovable tile

    35

 * @param t the tile to get the type from.

    36

 * @pre IsTileType(t, MP_UNMOVABLE)

    37

 * @return the type.

    38

 */

    39

static inline UnmovableType GetUnmovableType(TileIndex t)

    40

{

    41

	assert(IsTileType(t, MP_UNMOVABLE));

    42

	return (UnmovableType)_m[t].m5;

    43

}

    44

    45

/**

    46

 * Does the given tile have a transmitter?

    47

 * @param t the tile to inspect.

    48

 * @return true if and only if the tile has a transmitter.

    49

 */

    50

static inline bool IsTransmitterTile(TileIndex t)

    51

{

    52

	return IsTileType(t, MP_UNMOVABLE) && GetUnmovableType(t) == UNMOVABLE_TRANSMITTER;

    53

}

    54

    55

/**

    56

 * Is this unmovable tile an 'owned land' tile?

    57

 * @param t the tile to inspect.

    58

 * @pre IsTileType(t, MP_UNMOVABLE)

    59

 * @return true if and only if the tile is an 'owned land' tile.

    60

 */

    61

static inline bool IsOwnedLand(TileIndex t)

    62

{

    63

	assert(IsTileType(t, MP_UNMOVABLE));

    64

	return GetUnmovableType(t) == UNMOVABLE_OWNED_LAND;

    65

}

    66

    67

/**

    68

 * Is the given tile (pre-)owned by someone (the little flags)?

    69

 * @param t the tile to inspect.

    70

 * @return true if and only if the tile is an 'owned land' tile.

    71

 */

    72

static inline bool IsOwnedLandTile(TileIndex t)

    73

{

    74

	return IsTileType(t, MP_UNMOVABLE) && IsOwnedLand(t);

    75

}

    76

    77

/**

    78

 * Is this unmovable tile a HQ tile?

    79

 * @param t the tile to inspect.

    80

 * @pre IsTileType(t, MP_UNMOVABLE)

    81

 * @return true if and only if the tile is a HQ tile.

    82

 */

    83

static inline bool IsCompanyHQ(TileIndex t)

    84

{

    85

	assert(IsTileType(t, MP_UNMOVABLE));

    86

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

    87

}

    88

    89

/**

    90

 * Is this unmovable tile a statue?

    91

 * @param t the tile to inspect.

    92

 * @pre IsTileType(t, MP_UNMOVABLE)

    93

 * @return true if and only if the tile is a statue.

    94

 */

    95

static inline bool IsStatue(TileIndex t)

    96

{

    97

	assert(IsTileType(t, MP_UNMOVABLE));

    98

	return GetUnmovableType(t) == UNMOVABLE_STATUE;

    99

}

   100

   101

/**

   102

 * Is the given tile a statue?

   103

 * @param t the tile to inspect.

   104

 * @return true if and only if the tile is a statue.

   105

 */

   106

static inline bool IsStatueTile(TileIndex t)

   107

{

   108

	return IsTileType(t, MP_UNMOVABLE) && IsStatue(t);

   109

}

   110

   111

/**

   112

 * Get the town of the given statue tile.

   113

 * @param t the tile of the statue.

   114

 * @pre IsStatueTile(t)

   115

 * @return the town the given statue is in.

   116

 */

   117

static inline TownID GetStatueTownID(TileIndex t)

   118

{

   119

	assert(IsStatueTile(t));

   120

	return _m[t].m2;

   121

}

   122

   123

/**

   124

 * Get the 'stage' of the HQ.

   125

 * @param t a tile of the HQ.

   126

 * @pre IsTileType(t, MP_UNMOVABLE) && IsCompanyHQ(t)

   127

 * @return the 'stage' of the HQ.

   128

 */

   129

static inline byte GetCompanyHQSize(TileIndex t)

   130

{

   131

	assert(IsTileType(t, MP_UNMOVABLE) && IsCompanyHQ(t));

   132

	return GB(_m[t].m5, 2, 3);

   133

}

   134

   135

/**

   136

 * Get the 'section' (including stage) of the HQ.

   137

 * @param t a tile of the HQ.

   138

 * @pre IsTileType(t, MP_UNMOVABLE) && IsCompanyHQ(t)

   139

 * @return the 'section' of the HQ.

   140

 */

   141

static inline byte GetCompanyHQSection(TileIndex t)

   142

{

   143

	assert(IsTileType(t, MP_UNMOVABLE) && IsCompanyHQ(t));

   144

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

   145

}

   146

   147

/**

   148

 * Enlarge the given HQ to the given size. If the new size

   149

 * is larger than the current size, nothing happens.

   150

 * @param t the tile of the HQ.

   151

 * @param size the new size of the HQ.

   152

 * @pre t is the northern tile of the HQ

   153

 */

   154

static inline void EnlargeCompanyHQ(TileIndex t, byte size)

   155

{

   156

	assert(GB(GetCompanyHQSection(t), 0, 2) == 0);

   157

   158

	size *= 4;

   159

	if (size <= _m[t].m5 - UNMOVABLE_HQ_NORTH) return;

   160

   161

	_m[t + TileDiffXY(0, 0)].m5 = UNMOVABLE_HQ_NORTH + size;

   162

	_m[t + TileDiffXY(0, 1)].m5 = UNMOVABLE_HQ_WEST  + size;

   163

	_m[t + TileDiffXY(1, 0)].m5 = UNMOVABLE_HQ_EAST  + size;

   164

	_m[t + TileDiffXY(1, 1)].m5 = UNMOVABLE_HQ_SOUTH + size;

   165

}

   166

   167

   168

/**

   169

 * Make an Unmovable tile.

   170

 * @note do not use this function directly. Use one of the other Make* functions.

   171

 * @param t the tile to make unmovable.

   172

 * @param u the unmovable type of the tile.

   173

 * @param o the new owner of the tile.

   174

 */

   175

static inline void MakeUnmovable(TileIndex t, UnmovableType u, Owner o)

   176

{

   177

	SetTileType(t, MP_UNMOVABLE);

   178

	SetTileOwner(t, o);

   179

	_m[t].m2 = 0;

   180

	_m[t].m3 = 0;

   181

	_m[t].m4 = 0;

   182

	_m[t].m5 = u;

   183

}

   184

   185

   186

/**

   187

 * Make a transmitter tile.

   188

 * @param t the tile to make a transmitter.

   189

 */

   190

static inline void MakeTransmitter(TileIndex t)

   191

{

   192

	MakeUnmovable(t, UNMOVABLE_TRANSMITTER, OWNER_NONE);

   193

}

   194

   195

/**

   196

 * Make a lighthouse tile.

   197

 * @param t the tile to make a transmitter.

   198

 */

   199

static inline void MakeLighthouse(TileIndex t)

   200

{

   201

	MakeUnmovable(t, UNMOVABLE_LIGHTHOUSE, OWNER_NONE);

   202

}

   203

   204

/**

   205

 * Make a statue tile.

   206

 * @param t the tile to make a statue.

   207

 * @param o the owner of the statue.

   208

 * @param town_id the town the statue was built in.

   209

 */

   210

static inline void MakeStatue(TileIndex t, Owner o, TownID town_id)

   211

{

   212

	MakeUnmovable(t, UNMOVABLE_STATUE, o);

   213

	_m[t].m2 = town_id;

   214

}

   215

   216

/**

   217

 * Make an 'owned land' tile.

   218

 * @param t the tile to make an 'owned land' tile.

   219

 * @param o the owner of the land.

   220

 */

   221

static inline void MakeOwnedLand(TileIndex t, Owner o)

   222

{

   223

	MakeUnmovable(t, UNMOVABLE_OWNED_LAND, o);

   224

}

   225

   226

/**

   227

 * Make an HQ with the give tile as it's northern tile.

   228

 * @param t the tile to make the northern tile of a HQ.

   229

 * @param o the owner of the HQ.

   230

 */

   231

static inline void MakeCompanyHQ(TileIndex t, Owner o)

   232

{

   233

	MakeUnmovable(t + TileDiffXY(0, 0), UNMOVABLE_HQ_NORTH, o);

   234

	MakeUnmovable(t + TileDiffXY(0, 1), UNMOVABLE_HQ_WEST, o);

   235

	MakeUnmovable(t + TileDiffXY(1, 0), UNMOVABLE_HQ_EAST, o);

   236

	MakeUnmovable(t + TileDiffXY(1, 1), UNMOVABLE_HQ_SOUTH, o);

   237

}

   238

   239

#endif /* UNMOVABLE_MAP_H */