1

/* $Id$ */

     2

     3

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

     4

     5

#ifndef NEWGRF_CANAL_H

     6

#define NEWGRF_CANAL_H

     7

     8

/** List of different canal 'features'.

     9

 * Each feature gets an entry in the canal spritegroup table */

    10

enum CanalFeature {

    11

	CF_WATERSLOPE,

    12

	CF_LOCKS,

    13

	CF_DIKES,

    14

	CF_ICON,

    15

	CF_DOCKS,

    16

	CF_RIVER_SLOPE,

    17

	CF_RIVER_EDGE,

    18

	CF_END,

    19

};

    20

    21

    22

struct WaterFeature {

    23

	const SpriteGroup *group;

    24

	uint8 callbackmask;

    25

	uint8 flags;

    26

};

    27

    28

    29

/** Table of canal 'feature' sprite groups */

    30

extern WaterFeature _water_feature[CF_END];

    31

    32

    33

/** Lookup the base sprite to use for a canal.

    34

 * @param feature Which canal feature we want.

    35

 * @param tile Tile index of canal, if appropriate.

    36

 * @return Base sprite returned by GRF, or 0 if none.

    37

 */

    38

SpriteID GetCanalSprite(CanalFeature feature, TileIndex tile);

    39

    40

#endif /* NEWGRF_CANAL_H */