Files @ r16729:482bfc615285
Branch filter:

Location: cpp/openttd-patchpack/source/src/water_map.h - annotation

rubidium
(svn r21472) -Fix [FS#4298] (r21459-ish): make sure the query window is only opened once per parent window / callback.
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r9111:983de9c5a848
r6432:3f618c3647c2
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r12989:383937fd7eba
r14248:a9050881acd7
r11967:df0600d2c7e7
r15411:59bf1a27a243
r6248:b940b09d7ab8
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r6248:b940b09d7ab8
r15038:4f765acd05a0
r5475:3f5cd13d1b63
r15411:59bf1a27a243
r6248:b940b09d7ab8
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r6248:b940b09d7ab8
r5475:3f5cd13d1b63
r15411:59bf1a27a243
r6248:b940b09d7ab8
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r6248:b940b09d7ab8
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r7739:a02c64c2fd31
r7739:a02c64c2fd31
r6181:1cf3114368df
r6181:1cf3114368df
r7954:1bdc1342cf47
r5475:3f5cd13d1b63
r7954:1bdc1342cf47
r6181:1cf3114368df
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r16037:8ed2804bc674
r15610:623a23fb6560
r15411:59bf1a27a243
r15933:39e6324db57a
r15411:59bf1a27a243
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r16037:8ed2804bc674
r15762:7fbf9fe78040
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15933:39e6324db57a
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r16037:8ed2804bc674
r15762:7fbf9fe78040
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r15610:623a23fb6560
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15933:39e6324db57a
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r6181:1cf3114368df
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r7739:a02c64c2fd31
r7739:a02c64c2fd31
r8471:0c8cd6eb92d6
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r6974:4cdfedad8a12
r6974:4cdfedad8a12
r8471:0c8cd6eb92d6
r6974:4cdfedad8a12
r6974:4cdfedad8a12
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8360:4a4998989c92
r8360:4a4998989c92
r8471:0c8cd6eb92d6
r8360:4a4998989c92
r8360:4a4998989c92
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r7739:a02c64c2fd31
r5475:3f5cd13d1b63
r7739:a02c64c2fd31
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r8383:3e97f6061bcc
r8471:0c8cd6eb92d6
r8383:3e97f6061bcc
r8383:3e97f6061bcc
r15610:623a23fb6560
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r16199:e5327cbb9669
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r7928:a80e7e05d6c5
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8966:c66d9ba9e0fc
r5475:3f5cd13d1b63
r7954:1bdc1342cf47
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8966:c66d9ba9e0fc
r8954:770c53d1c4f5
r8954:770c53d1c4f5
r8954:770c53d1c4f5
r8954:770c53d1c4f5
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15869:3237cbc42f75
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15867:ecad3e587c06
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8495:3d4bceb612db
r8029:8fa304783822
r8495:3d4bceb612db
r8029:8fa304783822
r8029:8fa304783822
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r6181:1cf3114368df
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8368:229f823c854a
r8368:229f823c854a
r8368:229f823c854a
r8368:229f823c854a
r8368:229f823c854a
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r16552:2145cf9259fa
r5475:3f5cd13d1b63
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15762:7fbf9fe78040
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r11289:7e06e1b4e52d
r11289:7e06e1b4e52d
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r8360:4a4998989c92
r8360:4a4998989c92
r13298:ddbc752190f3
r15762:7fbf9fe78040
r8360:4a4998989c92
r15762:7fbf9fe78040
r8368:229f823c854a
r8471:0c8cd6eb92d6
r11289:7e06e1b4e52d
r11289:7e06e1b4e52d
r8360:4a4998989c92
r8360:4a4998989c92
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r13298:ddbc752190f3
r8368:229f823c854a
r5475:3f5cd13d1b63
r7739:a02c64c2fd31
r13298:ddbc752190f3
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r12989:383937fd7eba
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15762:7fbf9fe78040
r12989:383937fd7eba
r15762:7fbf9fe78040
r8495:3d4bceb612db
r5475:3f5cd13d1b63
r11289:7e06e1b4e52d
r11289:7e06e1b4e52d
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15610:623a23fb6560
r15610:623a23fb6560
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15762:7fbf9fe78040
r5475:3f5cd13d1b63
r15762:7fbf9fe78040
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r11289:7e06e1b4e52d
r11289:7e06e1b4e52d
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r15411:59bf1a27a243
r8471:0c8cd6eb92d6
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r8471:0c8cd6eb92d6
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
r5475:3f5cd13d1b63
/* $Id$ */

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */

/** @file water_map.h Map accessors for water tiles. */

#ifndef WATER_MAP_H
#define WATER_MAP_H

#include "depot_type.h"
#include "tile_map.h"

/** Available water tile types. */
enum WaterTileType {
	WATER_TILE_CLEAR, // Plain water.
	WATER_TILE_COAST, // Coast.
	WATER_TILE_LOCK,  // Water lock.
	WATER_TILE_DEPOT, // Water Depot.
};

/** classes of water (for #WATER_TILE_CLEAR water tile type). */
enum WaterClass {
	WATER_CLASS_SEA,     ///< Sea.
	WATER_CLASS_CANAL,   ///< Canal.
	WATER_CLASS_RIVER,   ///< River.
	WATER_CLASS_INVALID, ///< Used for industry tiles on land (also for oilrig if newgrf says so).
};
template <> struct EnumPropsT<WaterClass> : MakeEnumPropsT<WaterClass, byte, WATER_CLASS_SEA, WATER_CLASS_INVALID, WATER_CLASS_INVALID, 2> {};

/** Sections of the water depot. */
enum DepotPart {
	DEPOT_NORTH = 0x80,
	DEPOT_SOUTH = 0x81,
	DEPOT_END   = 0x84,
};

/** Sections of the water lock. */
enum LockPart {
	LOCK_MIDDLE = 0x10,
	LOCK_LOWER  = 0x14,
	LOCK_UPPER  = 0x18,
	LOCK_END    = 0x1C
};

/**
 * Get the water tile type at a tile.
 * @param t Water tile to query.
 * @return Water tile type at the tile.
 */
static inline WaterTileType GetWaterTileType(TileIndex t)
{
	assert(IsTileType(t, MP_WATER));

	if (_m[t].m5 == 0) return WATER_TILE_CLEAR;
	if (_m[t].m5 == 1) return WATER_TILE_COAST;
	if (IsInsideMM(_m[t].m5, LOCK_MIDDLE, LOCK_END)) return WATER_TILE_LOCK;

	assert(IsInsideMM(_m[t].m5, DEPOT_NORTH, DEPOT_END));
	return WATER_TILE_DEPOT;
}

/**
 * Checks whether the tile has an waterclass associated.
 * You can then subsequently call GetWaterClass().
 * @param t Tile to query.
 * @return True if the tiletype has a waterclass.
 */
static inline bool HasTileWaterClass(TileIndex t)
{
	return IsTileType(t, MP_WATER) || IsTileType(t, MP_STATION) || IsTileType(t, MP_INDUSTRY) || IsTileType(t, MP_OBJECT);
}

/**
 * Get the water class at a tile.
 * @param t Water tile to query.
 * @pre IsTileType(t, MP_WATER) || IsTileType(t, MP_STATION) || IsTileType(t, MP_INDUSTRY) || IsTileType(t, MP_OBJECT)
 * @return Water class at the tile.
 */
static inline WaterClass GetWaterClass(TileIndex t)
{
	assert(HasTileWaterClass(t));
	return (WaterClass)GB(_m[t].m1, 5, 2);
}

/**
 * Set the water class at a tile.
 * @param t  Water tile to change.
 * @param wc New water class.
 * @pre IsTileType(t, MP_WATER) || IsTileType(t, MP_STATION) || IsTileType(t, MP_INDUSTRY) || IsTileType(t, MP_OBJECT)
 */
static inline void SetWaterClass(TileIndex t, WaterClass wc)
{
	assert(HasTileWaterClass(t));
	SB(_m[t].m1, 5, 2, wc);
}

/**
 * Tests if the tile was built on water.
 * @param t the tile to check
 * @pre IsTileType(t, MP_WATER) || IsTileType(t, MP_STATION) || IsTileType(t, MP_INDUSTRY) || IsTileType(t, MP_OBJECT)
 * @return true iff on water
 */
static inline bool IsTileOnWater(TileIndex t)
{
	return (GetWaterClass(t) != WATER_CLASS_INVALID);
}

/**
 * Is it a plain water tile?
 * @param t Water tile to query.
 * @return \c true if any type of clear water like ocean, river, or canal.
 */
static inline bool IsWater(TileIndex t)
{
	return GetWaterTileType(t) == WATER_TILE_CLEAR;
}

/**
 * Is it a sea water tile?
 * @param t Water tile to query.
 * @return \c true if it is a sea water tile.
 */
static inline bool IsSea(TileIndex t)
{
	return IsWater(t) && GetWaterClass(t) == WATER_CLASS_SEA;
}

/**
 * Is it a canal tile?
 * @param t Water tile to query.
 * @return \c true if it is a canal tile.
 */
static inline bool IsCanal(TileIndex t)
{
	return IsWater(t) && GetWaterClass(t) == WATER_CLASS_CANAL;
}

/**
 * Is it a river water tile?
 * @param t Water tile to query.
 * @return \c true if it is a river water tile.
 */
static inline bool IsRiver(TileIndex t)
{
	return IsWater(t) && GetWaterClass(t) == WATER_CLASS_RIVER;
}

/**
 * Is it a water tile with plain water?
 * @param t Tile to query.
 * @return \c true if it is a plain water tile.
 */
static inline bool IsWaterTile(TileIndex t)
{
	return IsTileType(t, MP_WATER) && IsWater(t);
}

/**
 * Is it a coast tile?
 * @param t Water tile to query.
 * @return \c true if it is a sea water tile.
 */
static inline bool IsCoast(TileIndex t)
{
	return GetWaterTileType(t) == WATER_TILE_COAST;
}

/**
 * Is it a coast tile
 * @param t Tile to query.
 * @return \c true if it is a coast.
 */
static inline bool IsCoastTile(TileIndex t)
{
	return IsTileType(t, MP_WATER) && IsCoast(t);
}

/**
 * Get the other tile of the ship depot.
 * @param t Tile to query, containing one section of a ship depot.
 * @return Tile containing the other section of the depot.
 */
static inline TileIndex GetOtherShipDepotTile(TileIndex t)
{
	return t + (HasBit(_m[t].m5, 0) ? -1 : 1) * (HasBit(_m[t].m5, 1) ? TileDiffXY(0, 1) : TileDiffXY(1, 0));
}

/**
 * Is it a water tile with a ship depot on it?
 * @param t Water tile to query.
 * @return \c true if it is a ship depot tile.
 */
static inline bool IsShipDepot(TileIndex t)
{
	return IsInsideMM(_m[t].m5, DEPOT_NORTH, DEPOT_END);
}

/**
 * Is it a ship depot tile?
 * @param t Tile to query.
 * @return \c true if it is a ship depot tile.
 */
static inline bool IsShipDepotTile(TileIndex t)
{
	return IsTileType(t, MP_WATER) && IsShipDepot(t);
}

/**
 * Get the axis of the ship depot.
 * @param t Water tile to query.
 * @return Axis of the depot.
 */
static inline Axis GetShipDepotAxis(TileIndex t)
{
	return (Axis)GB(_m[t].m5, 1, 1);
}

/**
 * Get the direction of the ship depot.
 * @param t Water tile to query.
 * @return Direction of the depot.
 */
static inline DiagDirection GetShipDepotDirection(TileIndex t)
{
	return XYNSToDiagDir(GetShipDepotAxis(t), GB(_m[t].m5, 0, 1));
}

/**
 * Get the most northern tile of a ship depot.
 * @param tile One of the tiles of the ship depot.
 * @return The northern tile of the depot.
 */
static inline TileIndex GetShipDepotNorthTile(TileIndex t)
{
	assert(IsShipDepot(t));
	TileIndex tile2 = GetOtherShipDepotTile(t);

	return t < tile2 ? t : tile2;
}

/**
 * Is it a water lock tile?
 * @param t Water tile to query.
 * @return \c true if it is a water lock tile.
 */
static inline bool IsLock(TileIndex t)
{
	return IsInsideMM(_m[t].m5, LOCK_MIDDLE, LOCK_END);
}

/**
 * Get the direction of the water lock.
 * @param t Water tile to query.
 * @return Direction of the lock.
 */
static inline DiagDirection GetLockDirection(TileIndex t)
{
	return (DiagDirection)GB(_m[t].m5, 0, 2);
}

/**
 * Get a section of a depot or a lock.
 * @param t Water tile to query.
 * @return The section.
 */
static inline byte GetSection(TileIndex t)
{
	assert(GetWaterTileType(t) == WATER_TILE_LOCK || GetWaterTileType(t) == WATER_TILE_DEPOT);
	return GB(_m[t].m5, 0, 4);
}

/**
 * Get the random bits of the water tile.
 * @param t Water tile to query.
 * @return Random bits of the tile.
 */
static inline byte GetWaterTileRandomBits(TileIndex t)
{
	return _m[t].m4;
}

/**
 * Checks whether the tile has water at the ground.
 * That is, it is either some plain water tile, or a object/industry/station/... with water under it.
 * @return true iff the tile has water at the ground.
 * @note Coast tiles are not considered waterish, even if there is water on a halftile.
 */
static inline bool HasTileWaterGround(TileIndex t)
{
	return HasTileWaterClass(t) && IsTileOnWater(t) && !IsCoastTile(t);
}


/**
 * Helper function to make a coast tile.
 * @param t The tile to change into water
 */
static inline void MakeShore(TileIndex t)
{
	SetTileType(t, MP_WATER);
	SetTileOwner(t, OWNER_WATER);
	SetWaterClass(t, WATER_CLASS_SEA);
	_m[t].m2 = 0;
	_m[t].m3 = 0;
	_m[t].m4 = 0;
	_m[t].m5 = 1;
	SB(_m[t].m6, 2, 4, 0);
	_me[t].m7 = 0;
}

/**
 * Helper function for making a watery tile.
 * @param t The tile to change into water
 * @param o The owner of the water
 * @param wc The class of water the tile has to be
 * @param random_bits Eventual random bits to be set for this tile
 */
static inline void MakeWater(TileIndex t, Owner o, WaterClass wc, uint8 random_bits)
{
	SetTileType(t, MP_WATER);
	SetTileOwner(t, o);
	SetWaterClass(t, wc);
	_m[t].m2 = 0;
	_m[t].m3 = 0;
	_m[t].m4 = random_bits;
	_m[t].m5 = 0;
	SB(_m[t].m6, 2, 4, 0);
	_me[t].m7 = 0;
}

/**
 * Make a sea tile.
 * @param t The tile to change into sea
 */
static inline void MakeSea(TileIndex t)
{
	MakeWater(t, OWNER_WATER, WATER_CLASS_SEA, 0);
}

/**
 * Make a river tile
 * @param t The tile to change into river
 * @param random_bits Random bits to be set for this tile
 */
static inline void MakeRiver(TileIndex t, uint8 random_bits)
{
	MakeWater(t, OWNER_WATER, WATER_CLASS_RIVER, random_bits);
}

/**
 * Make a canal tile
 * @param t The tile to change into canal
 * @param o The owner of the canal
 * @param random_bits Random bits to be set for this tile
 */
static inline void MakeCanal(TileIndex t, Owner o, uint8 random_bits)
{
	assert(o != OWNER_WATER);
	MakeWater(t, o, WATER_CLASS_CANAL, random_bits);
}

/**
 * Make a ship depot section.
 * @param t    Tile to place the ship depot section.
 * @param o    Owner of the depot.
 * @param did  Depot ID.
 * @param base Depot base (either #DEPOT_NORTH or #DEPOT_SOUTH).
 * @param a    Axis of the depot.
 * @param original_water_class Original water class.
 */
static inline void MakeShipDepot(TileIndex t, Owner o, DepotID did, DepotPart base, Axis a, WaterClass original_water_class)
{
	SetTileType(t, MP_WATER);
	SetTileOwner(t, o);
	SetWaterClass(t, original_water_class);
	_m[t].m2 = did;
	_m[t].m3 = 0;
	_m[t].m4 = 0;
	_m[t].m5 = base + a * 2;
	SB(_m[t].m6, 2, 4, 0);
	_me[t].m7 = 0;
}

/**
 * Make a lock section.
 * @param t Tile to place the water lock section.
 * @param o Owner of the lock.
 * @param section Section to place.
 * @param original_water_class Original water class.
 * @see MakeLock
 */
static inline void MakeLockTile(TileIndex t, Owner o, byte section, WaterClass original_water_class)
{
	SetTileType(t, MP_WATER);
	SetTileOwner(t, o);
	SetWaterClass(t, original_water_class);
	_m[t].m2 = 0;
	_m[t].m3 = 0;
	_m[t].m4 = 0;
	_m[t].m5 = section;
	SB(_m[t].m6, 2, 4, 0);
	_me[t].m7 = 0;
}

/**
 * Make a water lock.
 * @param t Tile to place the water lock section.
 * @param o Owner of the lock.
 * @param d Direction of the water lock.
 * @param wc_lower Original water class of the lower part.
 * @param wc_upper Original water class of the upper part.
 */
static inline void MakeLock(TileIndex t, Owner o, DiagDirection d, WaterClass wc_lower, WaterClass wc_upper)
{
	TileIndexDiff delta = TileOffsByDiagDir(d);

	MakeLockTile(t, o, LOCK_MIDDLE + d, WATER_CLASS_CANAL);
	MakeLockTile(t - delta, o, LOCK_LOWER + d, wc_lower);
	MakeLockTile(t + delta, o, LOCK_UPPER + d, wc_upper);
}

#endif /* WATER_MAP_H */