1

/* $Id$ */

     2

     3

/** @file unmovable_map.h */

     4

     5

#ifndef UNMOVABLE_MAP_H

     6

#define UNMOVABLE_MAP_H

     7

     8

enum {

     9

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

    10

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

    11

};

    12

    13

/** Types of unmovable structure */

    14

enum UnmovableType {

    15

	UNMOVABLE_TRANSMITTER = 0,    ///< The large antenna

    16

	UNMOVABLE_LIGHTHOUSE  = 1,    ///< The nice lighthouse

    17

	UNMOVABLE_STATUE      = 2,    ///< Statue in towns

    18

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

    19

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

    20

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

    21

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

    22

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

    23

    24

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

    25

	UNMOVABLE_HQ_END      = UNMOVABLE_HQ_NORTH + HQ_NUM_SIZE * HQ_NUM_TILE

    26

};

    27

    28

    29

    30

/**

    31

 * Gets the UnmovableType of the given unmovable tile

    32

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

    33

 * @pre IsTileType(t, MP_UNMOVABLE)

    34

 * @return the type.

    35

 */

    36

static inline UnmovableType GetUnmovableType(TileIndex t)

    37

{

    38

	assert(IsTileType(t, MP_UNMOVABLE));

    39

	return (UnmovableType)_m[t].m5;

    40

}

    41

    42

/**

    43

 * Does the given tile have a transmitter?

    44

 * @param t the tile to inspect.

    45

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

    46

 */

    47

static inline bool IsTransmitterTile(TileIndex t)

    48

{

    49

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

    50

}

    51

    52

/**

    53

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

    54

 * @param t the tile to inspect.

    55

 * @pre IsTileType(t, MP_UNMOVABLE)

    56

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

    57

 */

    58

static inline bool IsOwnedLand(TileIndex t)

    59

{

    60

	assert(IsTileType(t, MP_UNMOVABLE));

    61

	return GetUnmovableType(t) == UNMOVABLE_OWNED_LAND;

    62

}

    63

    64

/**

    65

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

    66

 * @param t the tile to inspect.

    67

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

    68

 */

    69

static inline bool IsOwnedLandTile(TileIndex t)

    70

{

    71

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

    72

}

    73

    74

/**

    75

 * Is this unmovable tile a HQ tile?

    76

 * @param t the tile to inspect.

    77

 * @pre IsTileType(t, MP_UNMOVABLE)

    78

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

    79

 */

    80

static inline bool IsCompanyHQ(TileIndex t)

    81

{

    82

	assert(IsTileType(t, MP_UNMOVABLE));

    83

	return IS_INT_INSIDE(GetUnmovableType(t), UNMOVABLE_HQ_NORTH, UNMOVABLE_HQ_END);

    84

}

    85

    86

/**

    87

 * Is this unmovable tile a statue?

    88

 * @param t the tile to inspect.

    89

 * @pre IsTileType(t, MP_UNMOVABLE)

    90

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

    91

 */

    92

static inline bool IsStatue(TileIndex t)

    93

{

    94

	assert(IsTileType(t, MP_UNMOVABLE));

    95

	return GetUnmovableType(t) == UNMOVABLE_STATUE;

    96

}

    97

    98

/**

    99

 * Is the given tile a statue?

   100

 * @param t the tile to inspect.

   101

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

   102

 */

   103

static inline bool IsStatueTile(TileIndex t)

   104

{

   105

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

   106

}

   107

   108

/**

   109

 * Get the town of the given statue tile.

   110

 * @param t the tile of the statue.

   111

 * @pre IsStatueTile(t)

   112

 * @return the town the given statue is in.

   113

 */

   114

static inline TownID GetStatueTownID(TileIndex t)

   115

{

   116

	assert(IsStatueTile(t));

   117

	return _m[t].m2;

   118

}

   119

   120

/**

   121

 * Get the 'stage' of the HQ.

   122

 * @param t a tile of the HQ.

   123

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

   124

 * @return the 'stage' of the HQ.

   125

 */

   126

static inline byte GetCompanyHQSize(TileIndex t)

   127

{

   128

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

   129

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

   130

}

   131

   132

/**

   133

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

   134

 * @param t a tile of the HQ.

   135

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

   136

 * @return the 'section' of the HQ.

   137

 */

   138

static inline byte GetCompanyHQSection(TileIndex t)

   139

{

   140

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

   141

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

   142

}

   143

   144

/**

   145

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

   146

 * is larger than the current size, nothing happens.

   147

 * @param t the tile of the HQ.

   148

 * @param size the new size of the HQ.

   149

 * @pre t is the northern tile of the HQ

   150

 */

   151

static inline void EnlargeCompanyHQ(TileIndex t, byte size)

   152

{

   153

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

   154

   155

	size *= 4;

   156

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

   157

   158

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

   159

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

   160

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

   161

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

   162

}

   163

   164

   165

/**

   166

 * Make an Unmovable tile.

   167

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

   168

 * @param t the tile to make unmovable.

   169

 * @param u the unmovable type of the tile.

   170

 * @param o the new owner of the tile.

   171

 */

   172

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

   173

{

   174

	SetTileType(t, MP_UNMOVABLE);

   175

	SetTileOwner(t, o);

   176

	_m[t].m2 = 0;

   177

	_m[t].m3 = 0;

   178

	_m[t].m4 = 0;

   179

	_m[t].m5 = u;

   180

}

   181

   182

   183

/**

   184

 * Make a transmitter tile.

   185

 * @param t the tile to make a transmitter.

   186

 */

   187

static inline void MakeTransmitter(TileIndex t)

   188

{

   189

	MakeUnmovable(t, UNMOVABLE_TRANSMITTER, OWNER_NONE);

   190

}

   191

   192

/**

   193

 * Make a lighthouse tile.

   194

 * @param t the tile to make a transmitter.

   195

 */

   196

static inline void MakeLighthouse(TileIndex t)

   197

{

   198

	MakeUnmovable(t, UNMOVABLE_LIGHTHOUSE, OWNER_NONE);

   199

}

   200

   201

/**

   202

 * Make a statue tile.

   203

 * @param t the tile to make a statue.

   204

 * @param o the owner of the statue.

   205

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

   206

 */

   207

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

   208

{

   209

	MakeUnmovable(t, UNMOVABLE_STATUE, o);

   210

	_m[t].m2 = town_id;

   211

}

   212

   213

/**

   214

 * Make an 'owned land' tile.

   215

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

   216

 * @param o the owner of the land.

   217

 */

   218

static inline void MakeOwnedLand(TileIndex t, Owner o)

   219

{

   220

	MakeUnmovable(t, UNMOVABLE_OWNED_LAND, o);

   221

}

   222

   223

/**

   224

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

   225

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

   226

 * @param o the owner of the HQ.

   227

 */

   228

static inline void MakeCompanyHQ(TileIndex t, Owner o)

   229

{

   230

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

   231

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

   232

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

   233

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

   234

}

   235

   236

#endif /* UNMOVABLE_MAP_H */