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 "company_type.h"

    16

#include "direction_type.h"

    17

#include "track_type.h"

    18

#include "transport_type.h"

    19

    20

/** The returned bits of VehicleEnterTile. */

    21

enum VehicleEnterTileStatus {

    22

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

    23

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

    24

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

    25

    26

	/**

    27

	 * Shift the VehicleEnterTileStatus this many bits

    28

	 * to the right to get the station ID when

    29

	 * VETS_ENTERED_STATION is set

    30

	 */

    31

	VETS_STATION_ID_OFFSET = 8,

    32

	VETS_STATION_MASK      = 0xFFFF << VETS_STATION_ID_OFFSET,

    33

    34

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

    35

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

    36

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

    37

	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)

    38

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

    39

};

    40

DECLARE_ENUM_AS_BIT_SET(VehicleEnterTileStatus);

    41

    42

/** Tile information, used while rendering the tile */

    43

struct TileInfo {

    44

	uint x;         ///< X position of the tile in unit coordinates

    45

	uint y;         ///< Y position of the tile in unit coordinates

    46

	Slope tileh;    ///< Slope of the tile

    47

	TileIndex tile; ///< Tile index

    48

	uint z;         ///< Height

    49

};

    50

    51

/** Tile description for the 'land area information' tool */

    52

struct TileDesc {

    53

	StringID str;           ///< Description of the tile

    54

	Owner owner[4];         ///< Name of the owner(s)

    55

	StringID owner_type[4]; ///< Type of each owner

    56

	Date build_date;        ///< Date of construction of tile contents

    57

	StringID station_class; ///< Class of station

    58

	StringID station_name;  ///< Type of station within the class

    59

	const char *grf;        ///< newGRF used for the tile contents

    60

	uint64 dparam[2];       ///< Parameters of the \a str string

    61

};

    62

    63

/**

    64

 * Tile callback function signature for drawing a tile and its contents to the screen

    65

 * @param ti Information about the tile to draw

    66

 */

    67

typedef void DrawTileProc(TileInfo *ti);

    68

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

    69

typedef CommandCost ClearTileProc(TileIndex tile, byte flags);

    70

    71

/**

    72

 * Tile callback function signature for obtaining accepted carog of a tile

    73

 * @param tile Tile queried for its accepted cargo

    74

 * @param res  Storage destination of the cargo accepted

    75

 */

    76

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

    77

    78

/**

    79

 * Tile callback function signature for obtaining a tile description

    80

 * @param tile Tile being queried

    81

 * @param td   Storage pointer for returned tile description

    82

 */

    83

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

    84

    85

/**

    86

 * Tile callback function signature for getting the possible tracks

    87

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

    88

 *

    89

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

    90

 *

    91

 * see track_func.h for usage of TrackStatus.

    92

 *

    93

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

    94

 * @param mode     the mode of transportation

    95

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

    96

 * @return the track status information

    97

 */

    98

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

    99

   100

/**

   101

 * Tile callback function signature for obtaining the produced cargo of a tile.

   102

 * @param tile Tile being queried

   103

 * @param b    Destination array of produced cargo

   104

 */

   105

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

   106

typedef void ClickTileProc(TileIndex tile);

   107

typedef void AnimateTileProc(TileIndex tile);

   108

typedef void TileLoopProc(TileIndex tile);

   109

typedef void ChangeTileOwnerProc(TileIndex tile, Owner old_owner, Owner new_owner);

   110

   111

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

   112

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

   113

typedef Foundation GetFoundationProc(TileIndex tile, Slope tileh);

   114

   115

/**

   116

 * Tile callback function signature of the terraforming callback.

   117

 *

   118

 * The function is called when a tile is affected by a terraforming operation.

   119

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

   120

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

   121

 *

   122

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

   123

 *

   124

 * @param tile      The involved tile.

   125

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

   126

 * @param z_new     TileZ after terraforming.

   127

 * @param tileh_new Slope after terraforming.

   128

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

   129

 */

   130

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

   131

   132

/**

   133

 * Set of callback functions for performing tile operations of a given tile type.

   134

 * @see TileType */

   135

struct TileTypeProcs {

   136

	DrawTileProc *draw_tile_proc;                  ///< Called to render the tile and its contents to the screen

   137

	GetSlopeZProc *get_slope_z_proc;

   138

	ClearTileProc *clear_tile_proc;

   139

	GetAcceptedCargoProc *get_accepted_cargo_proc; ///< Return accepted cargo of the tile

   140

	GetTileDescProc *get_tile_desc_proc;           ///< Get a description of a tile (for the 'land area information' tool)

   141

	GetTileTrackStatusProc *get_tile_track_status_proc; ///< Get available tracks and status of a tile

   142

	ClickTileProc *click_tile_proc;                ///< Called when tile is clicked

   143

	AnimateTileProc *animate_tile_proc;

   144

	TileLoopProc *tile_loop_proc;

   145

	ChangeTileOwnerProc *change_tile_owner_proc;

   146

	GetProducedCargoProc *get_produced_cargo_proc; ///< Return produced cargo of the tile

   147

	VehicleEnterTileProc *vehicle_enter_tile_proc; ///< Called when a vehicle enters a tile

   148

	GetFoundationProc *get_foundation_proc;

   149

	TerraformTileProc *terraform_tile_proc;        ///< Called when a terraforming operation is about to take place

   150

};

   151

   152

extern const TileTypeProcs * const _tile_type_procs[16];

   153

   154

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

   155

void GetAcceptedCargo(TileIndex tile, AcceptedCargo ac);

   156

void ChangeTileOwner(TileIndex tile, Owner old_owner, Owner new_owner);

   157

void AnimateTile(TileIndex tile);

   158

void ClickTile(TileIndex tile);

   159

void GetTileDesc(TileIndex tile, TileDesc *td);

   160

   161

#endif /* TILE_CMD_H */