OpenTTD Source 20260208-master-g43af8e94d0
newgrf_canal.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#ifndef NEWGRF_CANAL_H
11#define NEWGRF_CANAL_H
12
13#include "newgrf.h"
14#include "newgrf_callbacks.h"
15#include "tile_type.h"
16
18enum CanalFeatureFlag : uint8_t {
20};
21
24 const SpriteGroup *group = nullptr;
25 const GRFFile *grffile = nullptr;
26 CanalCallbackMasks callback_mask = {};
27 uint8_t flags = 0;
28};
29
30
32extern std::array<WaterFeature, CF_END> _water_feature;
33
34
36
37uint GetCanalSpriteOffset(CanalFeature feature, TileIndex tile, uint cur_offset);
38
39#endif /* NEWGRF_CANAL_H */
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
Base for the NewGRF implementation.
CanalFeature
List of different canal 'features'.
Definition newgrf.h:27
Callbacks that NewGRFs could implement.
std::array< WaterFeature, CF_END > _water_feature
Table of canal 'feature' sprite groups.
uint GetCanalSpriteOffset(CanalFeature feature, TileIndex tile, uint cur_offset)
Get the new sprite offset for a water tile.
SpriteID GetCanalSprite(CanalFeature feature, TileIndex tile)
Lookup the base sprite to use for a canal.
CanalFeatureFlag
Flags controlling the display of canals.
@ CFF_HAS_FLAT_SPRITE
Additional flat ground sprite in the beginning.
Dynamic data of a loaded NewGRF.
Definition newgrf.h:117
Information about a water feature.
const SpriteGroup * group
Sprite group to start resolving.
const GRFFile * grffile
NewGRF where 'group' belongs to.
CanalCallbackMasks callback_mask
Bitmask of canal callbacks that have to be called.
uint8_t flags
Flags controlling display.
Types related to tiles.
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92