1

/* $Id$ */

     2

     3

/** @file src/roadveh.h Road vehicle states */

     4

     5

#ifndef ROADVEH_H

     6

#define ROADVEH_H

     7

     8

#include "vehicle_base.h"

     9

#include "engine_func.h"

    10

#include "engine_base.h"

    11

#include "economy_func.h"

    12

    13

enum RoadVehicleSubType {

    14

	RVST_FRONT,

    15

	RVST_ARTIC_PART,

    16

};

    17

    18

static inline bool IsRoadVehFront(const Vehicle *v)

    19

{

    20

	assert(v->type == VEH_ROAD);

    21

	return v->subtype == RVST_FRONT;

    22

}

    23

    24

static inline void SetRoadVehFront(Vehicle *v)

    25

{

    26

	assert(v->type == VEH_ROAD);

    27

	v->subtype = RVST_FRONT;

    28

}

    29

    30

static inline bool IsRoadVehArticPart(const Vehicle *v)

    31

{

    32

	assert(v->type == VEH_ROAD);

    33

	return v->subtype == RVST_ARTIC_PART;

    34

}

    35

    36

static inline void SetRoadVehArticPart(Vehicle *v)

    37

{

    38

	assert(v->type == VEH_ROAD);

    39

	v->subtype = RVST_ARTIC_PART;

    40

}

    41

    42

static inline bool RoadVehHasArticPart(const Vehicle *v)

    43

{

    44

	assert(v->type == VEH_ROAD);

    45

	return v->Next() != NULL && IsRoadVehArticPart(v->Next());

    46

}

    47

    48

    49

void CcBuildRoadVeh(bool success, TileIndex tile, uint32 p1, uint32 p2);

    50

    51

byte GetRoadVehLength(const Vehicle *v);

    52

    53

void RoadVehUpdateCache(Vehicle *v);

    54

    55

    56

/**

    57

 * This class 'wraps' Vehicle; you do not actually instantiate this class.

    58

 * You create a Vehicle using AllocateVehicle, so it is added to the pool

    59

 * and you reinitialize that to a Train using:

    60

 *   v = new (v) RoadVehicle();

    61

 *

    62

 * As side-effect the vehicle type is set correctly.

    63

 */

    64

struct RoadVehicle : public Vehicle {

    65

	/** Initializes the Vehicle to a road vehicle */

    66

	RoadVehicle() { this->type = VEH_ROAD; }

    67

    68

	/** We want to 'destruct' the right class. */

    69

	virtual ~RoadVehicle() { this->PreDestructor(); }

    70

    71

	const char *GetTypeString() const { return "road vehicle"; }

    72

	void MarkDirty();

    73

	void UpdateDeltaXY(Direction direction);

    74

	ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_ROADVEH_INC : EXPENSES_ROADVEH_RUN; }

    75

	bool IsPrimaryVehicle() const { return IsRoadVehFront(this); }

    76

	SpriteID GetImage(Direction direction) const;

    77

	int GetDisplaySpeed() const { return this->cur_speed * 10 / 32; }

    78

	int GetDisplayMaxSpeed() const { return this->max_speed * 10 / 32; }

    79

	Money GetRunningCost() const { return RoadVehInfo(this->engine_type)->running_cost * GetPriceByIndex(RoadVehInfo(this->engine_type)->running_cost_class); }

    80

	bool IsInDepot() const { return this->u.road.state == RVSB_IN_DEPOT; }

    81

	bool IsStoppedInDepot() const;

    82

	void Tick();

    83

	void OnNewDay();

    84

	TileIndex GetOrderStationLocation(StationID station);

    85

	bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);

    86

};

    87

    88

#endif /* ROADVEH_H */