author | rubidium |
Wed, 07 May 2008 21:45:27 +0000 | |
changeset 10457 | ea18877d8eba |
parent 10382 | d1d4452acbfc |
permissions | -rw-r--r-- |
3959 | 1 |
/* $Id$ */ |
2 |
||
6913 | 3 |
/** @file src/roadveh.h Road vehicle states */ |
6889
f7f6d9cb07a0
(svn r9523) -Cleanup: doxygen changes. Time to take care of "R"
belugas
parents:
6585
diff
changeset
|
4 |
|
4666
850b5b6e4bac
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4653
diff
changeset
|
5 |
#ifndef ROADVEH_H |
850b5b6e4bac
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4653
diff
changeset
|
6 |
#define ROADVEH_H |
850b5b6e4bac
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4653
diff
changeset
|
7 |
|
8640
1e93b81e96d2
(svn r11706) -Codechange: split vehicle.h and remove another bunch of useless includes.
rubidium
parents:
8612
diff
changeset
|
8 |
#include "vehicle_base.h" |
9282
2bb9703aeb39
(svn r12490) -Codechange: rename engine.h to engine_func.h and remove unneeded inclusions of engine.h and/or replace them with engine_type.h.
rubidium
parents:
9122
diff
changeset
|
9 |
#include "engine_func.h" |
10382
d1d4452acbfc
(svn r12924) -Feature: Introducing the so called 'engine pool' which primarily removes the fixed engine type limits and also happens to allow (with the patch option 'dynamic_engines') multiple NewGRF vehicle sets to coexist.
peter1138
parents:
10321
diff
changeset
|
10 |
#include "engine_base.h" |
8612
6414fc21c2f3
(svn r11677) -Codechange: move price and command related types/functions to their respective places.
rubidium
parents:
8044
diff
changeset
|
11 |
#include "economy_func.h" |
3959 | 12 |
|
7353
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
13 |
enum RoadVehicleSubType { |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
14 |
RVST_FRONT, |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
15 |
RVST_ARTIC_PART, |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
16 |
}; |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
17 |
|
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
18 |
static inline bool IsRoadVehFront(const Vehicle *v) |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
19 |
{ |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
20 |
assert(v->type == VEH_ROAD); |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
21 |
return v->subtype == RVST_FRONT; |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
22 |
} |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
23 |
|
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
24 |
static inline void SetRoadVehFront(Vehicle *v) |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
25 |
{ |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
26 |
assert(v->type == VEH_ROAD); |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
27 |
v->subtype = RVST_FRONT; |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
28 |
} |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
29 |
|
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
30 |
static inline bool IsRoadVehArticPart(const Vehicle *v) |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
31 |
{ |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
32 |
assert(v->type == VEH_ROAD); |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
33 |
return v->subtype == RVST_ARTIC_PART; |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
34 |
} |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
35 |
|
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
36 |
static inline void SetRoadVehArticPart(Vehicle *v) |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
37 |
{ |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
38 |
assert(v->type == VEH_ROAD); |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
39 |
v->subtype = RVST_ARTIC_PART; |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
40 |
} |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
41 |
|
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
42 |
static inline bool RoadVehHasArticPart(const Vehicle *v) |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
43 |
{ |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
44 |
assert(v->type == VEH_ROAD); |
7988
6075538f6111
(svn r11003) -Codechange: replace Vehicle->next to Vehicle->Next() and Vehicle->SetNext() so we can trap instances that change a next pointer and (in the future) update the first/previous pointers based on that.
rubidium
parents:
7986
diff
changeset
|
45 |
return v->Next() != NULL && IsRoadVehArticPart(v->Next()); |
7353
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
46 |
} |
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
47 |
|
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
48 |
|
6037
7409c8f581e1
(svn r8338) -Codechange: merged road vehicle build window into the other ones
bjarni
parents:
5726
diff
changeset
|
49 |
void CcBuildRoadVeh(bool success, TileIndex tile, uint32 p1, uint32 p2); |
4666
850b5b6e4bac
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4653
diff
changeset
|
50 |
|
10126
bed2d9d38577
(svn r12657) -Codechange: add 'FindClosestDepot' to the vehicle class.
rubidium
parents:
9323
diff
changeset
|
51 |
byte GetRoadVehLength(const Vehicle *v); |
bed2d9d38577
(svn r12657) -Codechange: add 'FindClosestDepot' to the vehicle class.
rubidium
parents:
9323
diff
changeset
|
52 |
|
bed2d9d38577
(svn r12657) -Codechange: add 'FindClosestDepot' to the vehicle class.
rubidium
parents:
9323
diff
changeset
|
53 |
void RoadVehUpdateCache(Vehicle *v); |
bed2d9d38577
(svn r12657) -Codechange: add 'FindClosestDepot' to the vehicle class.
rubidium
parents:
9323
diff
changeset
|
54 |
|
7048
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
55 |
|
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
56 |
/** |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
57 |
* This class 'wraps' Vehicle; you do not actually instantiate this class. |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
58 |
* You create a Vehicle using AllocateVehicle, so it is added to the pool |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
59 |
* and you reinitialize that to a Train using: |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
60 |
* v = new (v) RoadVehicle(); |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
61 |
* |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
62 |
* As side-effect the vehicle type is set correctly. |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
63 |
*/ |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
64 |
struct RoadVehicle : public Vehicle { |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
65 |
/** Initializes the Vehicle to a road vehicle */ |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
66 |
RoadVehicle() { this->type = VEH_ROAD; } |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
67 |
|
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
68 |
/** We want to 'destruct' the right class. */ |
7908
403a9694c42d
(svn r10798) -Fix [FS#1105]: virtual functions do not work in destructors :(.
rubidium
parents:
7814
diff
changeset
|
69 |
virtual ~RoadVehicle() { this->PreDestructor(); } |
7048
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
70 |
|
7059
3d5c57a7e729
(svn r9765) -Codechange: constify some class functions.
rubidium
parents:
7058
diff
changeset
|
71 |
const char *GetTypeString() const { return "road vehicle"; } |
7049
01825af2ce90
(svn r9755) -Codechange: refactor some more of the begin loading stuff.
rubidium
parents:
7048
diff
changeset
|
72 |
void MarkDirty(); |
7054
edbb4d7765f2
(svn r9760) -Codechange: remove the need for saving some vehicle variables.
rubidium
parents:
7049
diff
changeset
|
73 |
void UpdateDeltaXY(Direction direction); |
7059
3d5c57a7e729
(svn r9765) -Codechange: constify some class functions.
rubidium
parents:
7058
diff
changeset
|
74 |
ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_ROADVEH_INC : EXPENSES_ROADVEH_RUN; } |
7353
716c6dd9322a
(svn r10097) -Feature: Add support for articulated road vehicles, or callbacks 11 and 17 for
maedhros
parents:
7269
diff
changeset
|
75 |
bool IsPrimaryVehicle() const { return IsRoadVehFront(this); } |
10293
b3ca071d6716
(svn r12824) -Codechange: Standardise routines for drawing vehicle images, using correct types and less duplication.
peter1138
parents:
10126
diff
changeset
|
76 |
SpriteID GetImage(Direction direction) const; |
7973
ce69b7781d4a
(svn r10984) -Codechange: unify the way one can get the current speed in the same forwat so we can display it.
rubidium
parents:
7908
diff
changeset
|
77 |
int GetDisplaySpeed() const { return this->cur_speed * 10 / 32; } |
7980
9b12784cc39c
(svn r10995) -Codechange: unify the way to get the displayed maxium speed of a vehicle. Patch by nycom.
rubidium
parents:
7974
diff
changeset
|
78 |
int GetDisplayMaxSpeed() const { return this->max_speed * 10 / 32; } |
9122
bc3651767850
(svn r12209) -Fix: [NewGRF] Support using any base price for rail and road vehicles' running cost, and show running cost of wagons if they have it.
peter1138
parents:
8963
diff
changeset
|
79 |
Money GetRunningCost() const { return RoadVehInfo(this->engine_type)->running_cost * GetPriceByIndex(RoadVehInfo(this->engine_type)->running_cost_class); } |
7986
881998b115c2
(svn r11001) -Codechange: unify the way to determine whether a vehicle is in a depot.
rubidium
parents:
7984
diff
changeset
|
80 |
bool IsInDepot() const { return this->u.road.state == RVSB_IN_DEPOT; } |
7631
e810ef25497e
(svn r10409) -Codechange: replace (Aircraft|RoadVeh|Ship|Train)_Tick with a Tick method in the Vehicle class.
rubidium
parents:
7630
diff
changeset
|
81 |
void Tick(); |
8963
4b41ed1df7e5
(svn r12037) -Codechange: replace OnNewDay_(Aircraft|RoadVeh|Ship|Train) with an OnNewDay method in the Vehicle class
glx
parents:
8707
diff
changeset
|
82 |
void OnNewDay(); |
9323
9bc423363f6a
(svn r12575) -Codechange: unduplicate Process*Orders for trains, ships and road vehicles.
rubidium
parents:
9282
diff
changeset
|
83 |
TileIndex GetOrderStationLocation(StationID station); |
10126
bed2d9d38577
(svn r12657) -Codechange: add 'FindClosestDepot' to the vehicle class.
rubidium
parents:
9323
diff
changeset
|
84 |
bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse); |
7048
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
85 |
}; |
06b931095b26
(svn r9754) -Codechange: make classes for all vehicle types, so we can make nicer/better maintainable code, i.e. virtual methods instead of switches.
rubidium
parents:
6913
diff
changeset
|
86 |
|
4666
850b5b6e4bac
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4653
diff
changeset
|
87 |
#endif /* ROADVEH_H */ |