1

/* $Id$ */

     2

     3

/** @file tile_cmd.h Generic 'commands' that can be performed on all tiles. */

     4

     5

#ifndef TILE_CMD_H

     6

#define TILE_CMD_H

     7

     8

#include "slope_type.h"

     9

#include "tile_type.h"

    10

#include "command_type.h"

    11

#include "vehicle_type.h"

    12

#include "cargo_type.h"

    13

#include "strings_type.h"

    14

#include "date_type.h"

    15

#include "player_type.h"

    16

#include "direction_type.h"

    17

#include "track_type.h"

    18

    19

/** The returned bits of VehicleEnterTile. */

    20

enum VehicleEnterTileStatus {

    21

	VETS_ENTERED_STATION  = 1, ///< The vehicle entered a station

    22

	VETS_ENTERED_WORMHOLE = 2, ///< The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/tunnel)

    23

	VETS_CANNOT_ENTER     = 3, ///< The vehicle cannot enter the tile

    24

    25

	/**

    26

	 * Shift the VehicleEnterTileStatus this many bits

    27

	 * to the right to get the station ID when

    28

	 * VETS_ENTERED_STATION is set

    29

	 */

    30

	VETS_STATION_ID_OFFSET = 8,

    31

	VETS_STATION_MASK      = 0xFFFF << VETS_STATION_ID_OFFSET,

    32

    33

	/** Bit sets of the above specified bits */

    34

	VETSB_CONTINUE         = 0,                          ///< The vehicle can continue normally

    35

	VETSB_ENTERED_STATION  = 1 << VETS_ENTERED_STATION,  ///< The vehicle entered a station

    36

	VETSB_ENTERED_WORMHOLE = 1 << VETS_ENTERED_WORMHOLE, ///< The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/tunnel)

    37

	VETSB_CANNOT_ENTER     = 1 << VETS_CANNOT_ENTER,     ///< The vehicle cannot enter the tile

    38

};

    39

DECLARE_ENUM_AS_BIT_SET(VehicleEnterTileStatus);

    40

    41

struct TileInfo {

    42

	uint x;

    43

	uint y;

    44

	Slope tileh;

    45

	TileIndex tile;

    46

	uint z;

    47

};

    48

    49

struct TileDesc {

    50

	StringID str;

    51

	Owner owner;

    52

	Date build_date;

    53

	uint64 dparam[2];

    54

};

    55

    56

typedef void DrawTileProc(TileInfo *ti);

    57

typedef uint GetSlopeZProc(TileIndex tile, uint x, uint y);

    58

typedef CommandCost ClearTileProc(TileIndex tile, byte flags);

    59

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

    60

typedef void GetTileDescProc(TileIndex tile, TileDesc *td);

    61

    62

/**

    63

 * GetTileTrackStatusProcs return a value that contains the possible tracks

    64

 * that can be taken on a given tile by a given transport.

    65

 * The return value contains the existing trackdirs and signal states.

    66

 *

    67

 * see track_func.h for usage of TrackStatus.

    68

 *

    69

 * @param tile     the tile to get the track status from

    70

 * @param mode     the mode of transportation

    71

 * @param sub_mode used to differentiate between different kinds within the mode

    72

 * @return the track status information

    73

 */

    74

typedef TrackStatus GetTileTrackStatusProc(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side);

    75

typedef void GetProducedCargoProc(TileIndex tile, CargoID *b);

    76

typedef void ClickTileProc(TileIndex tile);

    77

typedef void AnimateTileProc(TileIndex tile);

    78

typedef void TileLoopProc(TileIndex tile);

    79

typedef void ChangeTileOwnerProc(TileIndex tile, PlayerID old_player, PlayerID new_player);

    80

    81

/** @see VehicleEnterTileStatus to see what the return values mean */

    82

typedef VehicleEnterTileStatus VehicleEnterTileProc(Vehicle *v, TileIndex tile, int x, int y);

    83

typedef Foundation GetFoundationProc(TileIndex tile, Slope tileh);

    84

    85

/**

    86

 * Called when a tile is affected by a terraforming operation.

    87

 * The function has to check if terraforming of the tile is allowed and return extra terraform-cost that depend on the tiletype.

    88

 * With DC_EXEC in flags it has to perform tiletype-specific actions (like clearing land etc., but not the terraforming itself).

    89

 *

    90

 * @note The terraforming has not yet taken place. So GetTileZ() and GetTileSlope() refer to the landscape before the terraforming operation.

    91

 *

    92

 * @param tile      The involved tile.

    93

 * @param flags     Command flags passed to the terraform command (DC_EXEC, DC_QUERY_COST, etc.).

    94

 * @param z_new     TileZ after terraforming.

    95

 * @param tileh_new Slope after terraforming.

    96

 * @return Error code or extra cost for terraforming (like clearing land, building foundations, etc., but not the terraforming itself.)

    97

 */

    98

typedef CommandCost TerraformTileProc(TileIndex tile, uint32 flags, uint z_new, Slope tileh_new);

    99

   100

struct TileTypeProcs {

   101

	DrawTileProc *draw_tile_proc;

   102

	GetSlopeZProc *get_slope_z_proc;

   103

	ClearTileProc *clear_tile_proc;

   104

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   105

	GetTileDescProc *get_tile_desc_proc;

   106

	GetTileTrackStatusProc *get_tile_track_status_proc;

   107

	ClickTileProc *click_tile_proc;

   108

	AnimateTileProc *animate_tile_proc;

   109

	TileLoopProc *tile_loop_proc;

   110

	ChangeTileOwnerProc *change_tile_owner_proc;

   111

	GetProducedCargoProc *get_produced_cargo_proc;

   112

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   113

	GetFoundationProc *get_foundation_proc;

   114

	TerraformTileProc *terraform_tile_proc;

   115

};

   116

   117

extern const TileTypeProcs * const _tile_type_procs[16];

   118

   119

TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side = INVALID_DIAGDIR);

   120

void GetAcceptedCargo(TileIndex tile, AcceptedCargo ac);

   121

void ChangeTileOwner(TileIndex tile, PlayerID old_player, PlayerID new_player);

   122

void AnimateTile(TileIndex tile);

   123

void ClickTile(TileIndex tile);

   124

void GetTileDesc(TileIndex tile, TileDesc *td);

   125

   126

#endif /* TILE_CMD_H */