src/newgrf_canal.h

   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 <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file newgrf_canal.h Handling of NewGRF canals. */
   9
  10 #ifndef NEWGRF_CANAL_H
  11 #define NEWGRF_CANAL_H
  12
  13 #include "newgrf.h"
  14 #include "tile_type.h"
  15
  16 /** Flags controlling the display of canals. */
  17 enum CanalFeatureFlag {
  18         CFF_HAS_FLAT_SPRITE = 0, ///< Additional flat ground sprite in the beginning.
  19 };
  20
  21 /** Information about a water feature. */
  22 struct WaterFeature {
  23         const SpriteGroup *group; ///< Sprite group to start resolving.
  24         const GRFFile *grffile;   ///< NewGRF where 'group' belongs to.
  25         uint8 callback_mask;      ///< Bitmask of canal callbacks that have to be called.
  26         uint8 flags;              ///< Flags controlling display.
  27 };
  28
  29
  30 /** Table of canal 'feature' sprite groups */
  31 extern WaterFeature _water_feature[CF_END];
  32
  33
  34 SpriteID GetCanalSprite(CanalFeature feature, TileIndex tile);
  35
  36 uint GetCanalSpriteOffset(CanalFeature feature, TileIndex tile, uint cur_offset);
  37
  38 #endif /* NEWGRF_CANAL_H */