/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

/** @file newgrf_canal.h Handling of NewGRF canals. */

#ifndef NEWGRF_CANAL_H
#define NEWGRF_CANAL_H

#include "newgrf.h"
#include "newgrf_callbacks.h"
#include "tile_type.h"

/** Flags controlling the display of canals. */
enum CanalFeatureFlag : uint8_t {
	CFF_HAS_FLAT_SPRITE = 0, ///< Additional flat ground sprite in the beginning.
};

/** Information about a water feature. */
struct WaterFeature {
	const SpriteGroup *group = nullptr; ///< Sprite group to start resolving.
	const GRFFile *grffile = nullptr; ///< NewGRF where 'group' belongs to.
	CanalCallbackMasks callback_mask = {}; ///< Bitmask of canal callbacks that have to be called.
	uint8_t flags = 0; ///< Flags controlling display.
};


/** Table of canal 'feature' sprite groups */
extern std::array<WaterFeature, CF_END> _water_feature;


SpriteID GetCanalSprite(CanalFeature feature, TileIndex tile);

uint GetCanalSpriteOffset(CanalFeature feature, TileIndex tile, uint cur_offset);

#endif /* NEWGRF_CANAL_H */
