src/newgrf_canal.h

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