OpenTTD Source: src/train_gui.cpp Source File

OpenTTD Source 13.1

train_gui.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #include "stdafx.h"
11 #include "window_gui.h"
12 #include "command_func.h"
13 #include "train.h"
14 #include "strings_func.h"
15 #include "vehicle_func.h"
16 #include "zoom_func.h"
17 #include "train_cmd.h"
18
19 #include "table/strings.h"
20
21 #include "safeguards.h"
22
30 void CcBuildWagon(Commands cmd, const CommandCost &result, VehicleID new_veh_id, uint, uint16, CargoArray, TileIndex tile, EngineID, bool, CargoID, ClientID)
31 {
32 if (result.Failed()) return;
33
34 /* find a locomotive in the depot. */
35 const Vehicle *found = nullptr;
36 for (const Train *t : Train::Iterate()) {
37 if (t->IsFrontEngine() && t->tile == tile && t->IsStoppedInDepot()) {
38 if (found != nullptr) return; // must be exactly one.
39 found = t;
40 }
41 }
42
43 /* if we found a loco, */
44 if (found != nullptr) {
45 found = found->Last();
46 /* put the new wagon at the end of the loco. */
47 Command<CMD_MOVE_RAIL_VEHICLE>::Post(found->tile, new_veh_id, found->index, false);
48 InvalidateWindowClassesData(WC_TRAINS_LIST, 0);
49 }
50 }
51
61 static int HighlightDragPosition(int px, int max_width, int y, VehicleID selection, bool chain)
62 {
63 bool rtl = _current_text_dir == TD_RTL;
64
65 assert(selection != INVALID_VEHICLE);
66 int dragged_width = 0;
67 for (Train *t = Train::Get(selection); t != nullptr; t = chain ? t->Next() : (t->HasArticulatedPart() ? t->GetNextArticulatedPart() : nullptr)) {
68 dragged_width += t->GetDisplayImageWidth(nullptr);
69 }
70
71 int drag_hlight_left = rtl ? std::max(px - dragged_width + 1, 0) : px;
72 int drag_hlight_right = rtl ? px : std::min(px + dragged_width, max_width) - 1;
73 int drag_hlight_width = std::max(drag_hlight_right - drag_hlight_left + 1, 0);
74
75 if (drag_hlight_width > 0) {
76 int height = ScaleSpriteTrad(12);
77 int top = y - height / 2;
78 Rect r = {drag_hlight_left, top, drag_hlight_right, top + height - 1};
79 /* Sprite-scaling is used here as the area is from sprite size */
80 GfxFillRect(r.Shrink(ScaleSpriteTrad(1)), _colour_gradient[COLOUR_GREY][7]);
81 }
82
83 return drag_hlight_width;
84 }
85
94 void DrawTrainImage(const Train *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest)
95 {
96 bool rtl = _current_text_dir == TD_RTL;
97 Direction dir = rtl ? DIR_E : DIR_W;
98
99 DrawPixelInfo tmp_dpi, *old_dpi;
100 /* Position of highlight box */
101 int highlight_l = 0;
102 int highlight_r = 0;
103 int max_width = r.Width();
104
105 if (!FillDrawPixelInfo(&tmp_dpi, r.left, r.top, r.Width(), r.Height())) return;
106
107 old_dpi = _cur_dpi;
108 _cur_dpi = &tmp_dpi;
109
110 int px = rtl ? max_width + skip : -skip;
111 int y = r.Height() / 2;
112 bool sel_articulated = false;
113 bool dragging = (drag_dest != INVALID_VEHICLE);
114 bool drag_at_end_of_train = (drag_dest == v->index); // Head index is used to mark dragging at end of train.
115 for (; v != nullptr && (rtl ? px > 0 : px < max_width); v = v->Next()) {
116 if (dragging && !drag_at_end_of_train && drag_dest == v->index) {
117 /* Highlight the drag-and-drop destination inside the train. */
118 int drag_hlight_width = HighlightDragPosition(px, max_width, y, selection, _cursor.vehchain);
119 px += rtl ? -drag_hlight_width : drag_hlight_width;
120 }
121
122 Point offset;
123 int width = Train::From(v)->GetDisplayImageWidth(&offset);
124
125 if (rtl ? px + width > 0 : px - width < max_width) {
126 PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
127 VehicleSpriteSeq seq;
128 v->GetImage(dir, image_type, &seq);
129 seq.Draw(px + (rtl ? -offset.x : offset.x), y + offset.y, pal, (v->vehstatus & VS_CRASHED) != 0);
130 }
131
132 if (!v->IsArticulatedPart()) sel_articulated = false;
133
134 if (v->index == selection) {
135 /* Set the highlight position */
136 highlight_l = rtl ? px - width : px;
137 highlight_r = rtl ? px - 1 : px + width - 1;
138 sel_articulated = true;
139 } else if ((_cursor.vehchain && highlight_r != 0) || sel_articulated) {
140 if (rtl) {
141 highlight_l -= width;
142 } else {
143 highlight_r += width;
144 }
145 }
146
147 px += rtl ? -width : width;
148 }
149
150 if (dragging && drag_at_end_of_train) {
151 /* Highlight the drag-and-drop destination at the end of the train. */
152 HighlightDragPosition(px, max_width, y, selection, _cursor.vehchain);
153 }
154
155 _cur_dpi = old_dpi;
156
157 if (highlight_l != highlight_r) {
158 /* Draw the highlight. Now done after drawing all the engines, as
159 * the next engine after the highlight could overlap it. */
160 int height = ScaleSpriteTrad(12);
161 Rect hr = {highlight_l, 0, highlight_r, height - 1};
162 DrawFrameRect(hr.Translate(r.left, CenterBounds(r.top, r.bottom, height)).Expand(WidgetDimensions::scaled.bevel), COLOUR_WHITE, FR_BORDERONLY);
163 }
164 }
165
167 struct CargoSummaryItem {
168 CargoID cargo;
169 StringID subtype;
170 uint capacity;
171 uint amount;
172 StationID source;
173
175 inline bool operator != (const CargoSummaryItem &other) const
176 {
177 return this->cargo != other.cargo || this->subtype != other.subtype;
178 }
179
181 inline bool operator == (const CargoSummaryItem &other) const
182 {
183 return !(this->cargo != other.cargo);
184 }
185 };
186
187 static const uint TRAIN_DETAILS_MIN_INDENT = 32;
188 static const uint TRAIN_DETAILS_MAX_INDENT = 72;
189
191 typedef std::vector<CargoSummaryItem> CargoSummary;
193 static CargoSummary _cargo_summary;
194
203 static void TrainDetailsCargoTab(const CargoSummaryItem *item, int left, int right, int y)
204 {
205 StringID str;
206 if (item->amount > 0) {
207 SetDParam(0, item->cargo);
208 SetDParam(1, item->amount);
209 SetDParam(2, item->source);
210 SetDParam(3, _settings_game.vehicle.freight_trains);
211 str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_DETAILS_CARGO_FROM_MULT : STR_VEHICLE_DETAILS_CARGO_FROM;
212 } else {
213 SetDParam(0, STR_QUANTITY_N_A);
214 str = item->cargo == INVALID_CARGO ? STR_LTBLUE_STRING : STR_VEHICLE_DETAILS_CARGO_EMPTY;
215 }
216
217 DrawString(left, right, y, str);
218 }
219
228 static void TrainDetailsInfoTab(const Vehicle *v, int left, int right, int y)
229 {
230 if (RailVehInfo(v->engine_type)->railveh_type == RAILVEH_WAGON) {
231 SetDParam(0, PackEngineNameDParam(v->engine_type, EngineNameContext::VehicleDetails));
232 SetDParam(1, v->value);
233 DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_WAGON_VALUE);
234 } else {
235 SetDParam(0, PackEngineNameDParam(v->engine_type, EngineNameContext::VehicleDetails));
236 SetDParam(1, v->build_year);
237 SetDParam(2, v->value);
238 DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_ENGINE_BUILT_AND_VALUE);
239 }
240 }
241
250 static void TrainDetailsCapacityTab(const CargoSummaryItem *item, int left, int right, int y)
251 {
252 StringID str;
253 if (item->cargo != INVALID_CARGO) {
254 SetDParam(0, item->cargo);
255 SetDParam(1, item->capacity);
256 SetDParam(4, item->subtype);
257 SetDParam(5, _settings_game.vehicle.freight_trains);
258 str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_INFO_CAPACITY_MULT : STR_VEHICLE_INFO_CAPACITY;
259 } else {
260 /* Draw subtype only */
261 SetDParam(0, item->subtype);
262 str = STR_VEHICLE_INFO_NO_CAPACITY;
263 }
264 DrawString(left, right, y, str);
265 }
266
272 static void GetCargoSummaryOfArticulatedVehicle(const Train *v, CargoSummary *summary)
273 {
274 summary->clear();
275 do {
276 if (!v->GetEngine()->CanCarryCargo()) continue;
277
278 CargoSummaryItem new_item;
279 new_item.cargo = v->cargo_cap > 0 ? v->cargo_type : INVALID_CARGO;
280 new_item.subtype = GetCargoSubtypeText(v);
281 if (new_item.cargo == INVALID_CARGO && new_item.subtype == STR_EMPTY) continue;
282
283 auto item = std::find(summary->begin(), summary->end(), new_item);
284 if (item == summary->end()) {
285 summary->emplace_back();
286 item = summary->end() - 1;
287 item->cargo = new_item.cargo;
288 item->subtype = new_item.subtype;
289 item->capacity = 0;
290 item->amount = 0;
291 item->source = INVALID_STATION;
292 }
293
294 item->capacity += v->cargo_cap;
295 item->amount += v->cargo.StoredCount();
296 if (item->source == INVALID_STATION) item->source = v->cargo.Source();
297 } while ((v = v->Next()) != nullptr && v->IsArticulatedPart());
298 }
299
305 static uint GetLengthOfArticulatedVehicle(const Train *v)
306 {
307 uint length = 0;
308
309 do {
310 length += v->GetDisplayImageWidth();
311 } while ((v = v->Next()) != nullptr && v->IsArticulatedPart());
312
313 return length;
314 }
315
322 int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab)
323 {
324 int num = 0;
325
326 if (det_tab == TDW_TAB_TOTALS) { // Total cargo tab
327 CargoArray act_cargo;
328 CargoArray max_cargo;
329 for (const Vehicle *v = Vehicle::Get(veh_id); v != nullptr; v = v->Next()) {
330 act_cargo[v->cargo_type] += v->cargo.StoredCount();
331 max_cargo[v->cargo_type] += v->cargo_cap;
332 }
333
334 /* Set scroll-amount separately from counting, as to not compute num double
335 * for more carriages of the same type
336 */
337 for (CargoID i = 0; i < NUM_CARGO; i++) {
338 if (max_cargo[i] > 0) num++; // only count carriages that the train has
339 }
340 num++; // needs one more because first line is description string
341 } else {
342 for (const Train *v = Train::Get(veh_id); v != nullptr; v = v->GetNextVehicle()) {
343 GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
344 num += std::max(1u, (unsigned)_cargo_summary.size());
345
346 uint length = GetLengthOfArticulatedVehicle(v);
347 if (length > (uint)ScaleSpriteTrad(TRAIN_DETAILS_MAX_INDENT)) num++;
348 }
349 }
350
351 return num;
352 }
353
363 void DrawTrainDetails(const Train *v, const Rect &r, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab)
364 {
365 bool rtl = _current_text_dir == TD_RTL;
366 int line_height = r.Height();
367 int sprite_y_offset = line_height / 2;
368 int text_y_offset = (line_height - FONT_HEIGHT_NORMAL) / 2;
369
370 /* draw the first 3 details tabs */
371 if (det_tab != TDW_TAB_TOTALS) {
372 Direction dir = rtl ? DIR_E : DIR_W;
373 int x = rtl ? r.right : r.left;
374 for (; v != nullptr && vscroll_pos > -vscroll_cap; v = v->GetNextVehicle()) {
375 GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
376
377 /* Draw sprites */
378 uint dx = 0;
379 int px = x;
380 const Train *u = v;
381 do {
382 Point offset;
383 int width = u->GetDisplayImageWidth(&offset);
384 if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
385 int pitch = 0;
386 const Engine *e = Engine::Get(v->engine_type);
387 if (e->GetGRF() != nullptr) {
388 pitch = ScaleSpriteTrad(e->GetGRF()->traininfo_vehicle_pitch);
389 }
390 PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
391 VehicleSpriteSeq seq;
392 u->GetImage(dir, EIT_IN_DETAILS, &seq);
393 seq.Draw(px + (rtl ? -offset.x : offset.x), r.top - line_height * vscroll_pos + sprite_y_offset + pitch, pal, (v->vehstatus & VS_CRASHED) != 0);
394 }
395 px += rtl ? -width : width;
396 dx += width;
397 u = u->Next();
398 } while (u != nullptr && u->IsArticulatedPart());
399
400 bool separate_sprite_row = (dx > (uint)ScaleSpriteTrad(TRAIN_DETAILS_MAX_INDENT));
401 if (separate_sprite_row) {
402 vscroll_pos--;
403 dx = 0;
404 }
405
406 int sprite_width = std::max<int>(dx, ScaleSpriteTrad(TRAIN_DETAILS_MIN_INDENT)) + WidgetDimensions::scaled.hsep_normal;
407 Rect dr = r.Indent(sprite_width, rtl);
408 uint num_lines = std::max(1u, (unsigned)_cargo_summary.size());
409 for (uint i = 0; i < num_lines; i++) {
410 if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
411 int py = r.top - line_height * vscroll_pos + text_y_offset;
412 if (i > 0 || separate_sprite_row) {
413 if (vscroll_pos != 0) GfxFillRect(r.left, py - WidgetDimensions::scaled.matrix.top - 1, r.right, py - WidgetDimensions::scaled.matrix.top, _colour_gradient[COLOUR_GREY][5]);
414 }
415 switch (det_tab) {
416 case TDW_TAB_CARGO:
417 if (i < _cargo_summary.size()) {
418 TrainDetailsCargoTab(&_cargo_summary[i], dr.left, dr.right, py);
419 } else {
420 DrawString(dr.left, dr.right, py, STR_QUANTITY_N_A, TC_LIGHT_BLUE);
421 }
422 break;
423
424 case TDW_TAB_INFO:
425 if (i == 0) TrainDetailsInfoTab(v, dr.left, dr.right, py);
426 break;
427
428 case TDW_TAB_CAPACITY:
429 if (i < _cargo_summary.size()) {
430 TrainDetailsCapacityTab(&_cargo_summary[i], dr.left, dr.right, py);
431 } else {
432 SetDParam(0, STR_EMPTY);
433 DrawString(dr.left, dr.right, py, STR_VEHICLE_INFO_NO_CAPACITY);
434 }
435 break;
436
437 default: NOT_REACHED();
438 }
439 }
440 vscroll_pos--;
441 }
442 }
443 } else {
444 int y = r.top;
445 CargoArray act_cargo;
446 CargoArray max_cargo;
447 Money feeder_share = 0;
448
449 for (const Vehicle *u = v; u != nullptr; u = u->Next()) {
450 act_cargo[u->cargo_type] += u->cargo.StoredCount();
451 max_cargo[u->cargo_type] += u->cargo_cap;
452 feeder_share += u->cargo.FeederShare();
453 }
454
455 /* draw total cargo tab */
456 DrawString(r.left, r.right, y + text_y_offset, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_TEXT);
457 y += line_height;
458
459 /* Indent the total cargo capacity details */
460 Rect ir = r.Indent(WidgetDimensions::scaled.hsep_indent, rtl);
461 for (CargoID i = 0; i < NUM_CARGO; i++) {
462 if (max_cargo[i] > 0 && --vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
463 SetDParam(0, i); // {CARGO} #1
464 SetDParam(1, act_cargo[i]); // {CARGO} #2
465 SetDParam(2, i); // {SHORTCARGO} #1
466 SetDParam(3, max_cargo[i]); // {SHORTCARGO} #2
467 SetDParam(4, _settings_game.vehicle.freight_trains);
468 DrawString(ir.left, ir.right, y + text_y_offset, FreightWagonMult(i) > 1 ? STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_MULT : STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY);
469 y += line_height;
470 }
471 }
472 SetDParam(0, feeder_share);
473 DrawString(r.left, r.right, y + text_y_offset, STR_VEHICLE_INFO_FEEDER_CARGO_VALUE);
474 }
475 }
Train::GetDisplayImageWidth
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
Definition: train_cmd.cpp:457
SpecializedVehicle::GetNextVehicle
T * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:1142
INVALID_CARGO
static const byte INVALID_CARGO
Constant representing invalid cargo.
Definition: cargotype.h:54
VehicleCargoList::StoredCount
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Definition: cargopacket.h:352
GetCargoSummaryOfArticulatedVehicle
static void GetCargoSummaryOfArticulatedVehicle(const Train *v, CargoSummary *summary)
Collects the cargo transported.
Definition: train_gui.cpp:272
Rect::Height
int Height() const
Get height of Rect.
Definition: geometry_type.hpp:85
Pool::PoolItem<&_vehicle_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
TDW_TAB_INFO
@ TDW_TAB_INFO
Tab with name and value of the vehicles.
Definition: vehicle_gui.h:27
Vehicle::value
Money value
Value of the vehicle.
Definition: vehicle_base.h:256
train.h
command_func.h
PackEngineNameDParam
uint64 PackEngineNameDParam(EngineID engine_id, EngineNameContext context, uint32 extra_data=0)
Combine an engine ID and a name context to an engine name dparam.
Definition: engine_type.h:196
DrawTrainDetails
void DrawTrainDetails(const Train *v, const Rect &r, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab)
Draw the details for the given vehicle at the given position.
Definition: train_gui.cpp:363
Commands
Commands
List of commands.
Definition: command_type.h:176
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:92
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1098
TrainDetailsWindowTabs
TrainDetailsWindowTabs
The tabs in the train details window.
Definition: vehicle_gui.h:25
CursorVars::vehchain
bool vehchain
vehicle chain is dragged
Definition: gfx_type.h:144
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:332
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:82
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
zoom_func.h
EIT_IN_DETAILS
@ EIT_IN_DETAILS
Vehicle drawn in vehicle details, refit window, ...
Definition: vehicle_type.h:89
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:644
DIR_W
@ DIR_W
West.
Definition: direction_type.h:32
Rect::Expand
Rect Expand(int s) const
Copy and expand Rect by s pixels.
Definition: geometry_type.hpp:147
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:86
Engine
Definition: engine_base.h:36
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:224
TrainDetailsCapacityTab
static void TrainDetailsCapacityTab(const CargoSummaryItem *item, int left, int right, int y)
Draw the details capacity tab for the given vehicle at the given position.
Definition: train_gui.cpp:250
VehicleSpriteSeq::Draw
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition: vehicle.cpp:126
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:55
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
TRAIN_DETAILS_MIN_INDENT
static const uint TRAIN_DETAILS_MIN_INDENT
Minimum indent level in the train details window.
Definition: train_gui.cpp:187
train_cmd.h
Vehicle::IsArticulatedPart
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition: vehicle_base.h:922
CargoSummaryItem::capacity
uint capacity
Amount that can be carried.
Definition: train_gui.cpp:170
TDW_TAB_TOTALS
@ TDW_TAB_TOTALS
Tab with sum of total cargo transported.
Definition: vehicle_gui.h:29
Engine::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:154
GRFFile::traininfo_vehicle_pitch
int traininfo_vehicle_pitch
Vertical offset for drawing train images in depot GUI and vehicle details.
Definition: newgrf.h:143
window_gui.h
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
CargoSummary
std::vector< CargoSummaryItem > CargoSummary
Container for the cargo summary information.
Definition: train_gui.cpp:191
CargoSummaryItem::source
StationID source
One of the source stations.
Definition: train_gui.cpp:172
CommandCost
Common return value for all commands.
Definition: command_type.h:24
Rect::Translate
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
Definition: geometry_type.hpp:168
WidgetDimensions::hsep_normal
int hsep_normal
Normal horizontal spacing.
Definition: window_gui.h:63
DIR_E
@ DIR_E
East.
Definition: direction_type.h:28
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:245
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:302
WidgetDimensions::matrix
RectPadding matrix
Offsets within a matrix cell.
Definition: window_gui.h:49
VS_CRASHED
@ VS_CRASHED
Vehicle is crashed.
Definition: vehicle_base.h:41
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:132
ClientID
ClientID
'Unique' identifier to be given to clients
Definition: network_type.h:47
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:324
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:160
ScaleSpriteTrad
static int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition: zoom_func.h:107
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:54
SpecializedVehicle< Train, Type >::Get
static Train * Get(size_t index)
Gets vehicle with given index.
Definition: vehicle_base.h:1164
_cargo_summary
static CargoSummary _cargo_summary
Reused container of cargo details.
Definition: train_gui.cpp:193
Vehicle::GetEngine
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:741
safeguards.h
Train
'Train' is either a loco or a wagon.
Definition: train.h:88
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition: geometry_type.hpp:192
TRAIN_DETAILS_MAX_INDENT
static const uint TRAIN_DETAILS_MAX_INDENT
Maximum indent level in the train details window; wider than this and we start on a new line.
Definition: train_gui.cpp:188
TrainDetailsInfoTab
static void TrainDetailsInfoTab(const Vehicle *v, int left, int right, int y)
Draw the details info tab for the given vehicle at the given position.
Definition: train_gui.cpp:228
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
VehicleDetails
@ VehicleDetails
Name is shown in the vehicle details GUI.
Definition: engine_type.h:190
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition: window_type.h:301
stdafx.h
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:116
RAILVEH_WAGON
@ RAILVEH_WAGON
simple wagon, not motorized
Definition: engine_type.h:29
FillDrawPixelInfo
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1786
GetCargoSubtypeText
StringID GetCargoSubtypeText(const Vehicle *v)
Get the cargo subtype text from NewGRF for the vehicle details window.
Definition: vehicle_gui.cpp:1280
CcBuildWagon
void CcBuildWagon(Commands cmd, const CommandCost &result, VehicleID new_veh_id, uint, uint16, CargoArray, TileIndex tile, EngineID, bool, CargoID, ClientID)
Callback for building wagons.
Definition: train_gui.cpp:30
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
HighlightDragPosition
static int HighlightDragPosition(int px, int max_width, int y, VehicleID selection, bool chain)
Highlight the position where a rail vehicle is dragged over by drawing a light gray background.
Definition: train_gui.cpp:61
vehicle_func.h
CargoSummaryItem
Helper struct for the cargo details information.
Definition: train_gui.cpp:167
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1598
strings_func.h
CargoSummaryItem::cargo
CargoID cargo
The cargo that is carried.
Definition: train_gui.cpp:168
TrainDetailsCargoTab
static void TrainDetailsCargoTab(const CargoSummaryItem *item, int left, int right, int y)
Draw the details cargo tab for the given vehicle at the given position.
Definition: train_gui.cpp:203
Vehicle::cargo_cap
uint16 cargo_cap
total capacity
Definition: vehicle_base.h:322
Engine::CanCarryCargo
bool CanCarryCargo() const
Determines whether an engine can carry something.
Definition: engine.cpp:164
TDW_TAB_CAPACITY
@ TDW_TAB_CAPACITY
Tab with cargo capacity of the vehicles.
Definition: vehicle_gui.h:28
SpecializedVehicle< Train, Type >::From
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1183
GetVehiclePalette
PaletteID GetVehiclePalette(const Vehicle *v)
Get the colour map for a vehicle.
Definition: vehicle.cpp:2062
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:206
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
InvalidateWindowClassesData
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3269
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
Vehicle::build_year
Year build_year
Year the vehicle has been built.
Definition: vehicle_base.h:272
WidgetDimensions::bevel
RectPadding bevel
Widths of bevel border.
Definition: window_gui.h:45
CargoSummaryItem::operator!=
bool operator!=(const CargoSummaryItem &other) const
Used by CargoSummary::Find() and similar functions.
Definition: train_gui.cpp:175
VehicleCargoList::Source
StationID Source() const
Returns source of the first cargo packet in this list.
Definition: cargopacket.h:323
SpecializedVehicle< Train, Type >::Iterate
static Pool::IterateWrapper< Train > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
Definition: vehicle_base.h:1252
Train::GetImage
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override
Get the sprite to display the train.
Definition: train_cmd.cpp:491
Vehicle::Last
Vehicle * Last()
Get the last vehicle of this vehicle chain.
Definition: vehicle_base.h:629
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:414
CommandHelper
Definition: command_func.h:94
CenterBounds
static int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:178
CargoSummaryItem::amount
uint amount
Amount that is carried.
Definition: train_gui.cpp:171
OverflowSafeInt< int64 >
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
CargoSummaryItem::operator==
bool operator==(const CargoSummaryItem &other) const
Used by std::find() and similar functions.
Definition: train_gui.cpp:181
Vehicle::cargo_type
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:320
GetLengthOfArticulatedVehicle
static uint GetLengthOfArticulatedVehicle(const Train *v)
Get the length of an articulated vehicle.
Definition: train_gui.cpp:305
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition: settings_type.h:595
CargoSummaryItem::subtype
StringID subtype
STR_EMPTY if none.
Definition: train_gui.cpp:169
Rect::Width
int Width() const
Get width of Rect.
Definition: geometry_type.hpp:79
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
GetTrainDetailsWndVScroll
int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab)
Determines the number of lines in the train details window.
Definition: train_gui.cpp:322
VehicleSettings::freight_trains
uint8 freight_trains
value to multiply the weight of cargo by
Definition: settings_type.h:500
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:69
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:49
FR_BORDERONLY
@ FR_BORDERONLY
Draw border only, no background.
Definition: window_gui.h:33
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
DrawTrainImage
void DrawTrainImage(const Train *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest)
Draws an image of a whole train.
Definition: train_gui.cpp:94
TDW_TAB_CARGO
@ TDW_TAB_CARGO
Tab with cargo carried by the vehicles.
Definition: vehicle_gui.h:26
FreightWagonMult
byte FreightWagonMult(CargoID cargo)
Return the cargo weight multiplier to use for a rail vehicle.
Definition: train_cmd.cpp:67