OpenTTD Source 20260208-master-g43af8e94d0
vehicle_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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "debug.h"
12#include "company_func.h"
13#include "gui.h"
14#include "textbuf_gui.h"
15#include "command_func.h"
16#include "vehicle_gui_base.h"
17#include "viewport_func.h"
18#include "newgrf_text.h"
19#include "newgrf_debug.h"
20#include "roadveh.h"
21#include "train.h"
22#include "aircraft.h"
23#include "depot_map.h"
24#include "group_gui.h"
25#include "strings_func.h"
26#include "vehicle_func.h"
27#include "autoreplace_gui.h"
28#include "string_func.h"
29#include "dropdown_type.h"
30#include "dropdown_func.h"
31#include "timetable.h"
35#include "company_base.h"
36#include "engine_func.h"
37#include "station_base.h"
38#include "tilehighlight_func.h"
39#include "zoom_func.h"
40#include "depot_cmd.h"
41#include "vehicle_cmd.h"
42#include "order_cmd.h"
43#include "roadveh_cmd.h"
44#include "train_cmd.h"
45#include "hotkeys.h"
46#include "group_cmd.h"
47
48#include "table/strings.h"
49
50#include "safeguards.h"
51
52
53static std::array<std::array<BaseVehicleListWindow::GroupBy, VEH_COMPANY_END>, VLT_END> _grouping{};
54static std::array<Sorting, BaseVehicleListWindow::GB_END> _sorting{};
55
56static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleNumberSorter;
57static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleNameSorter;
58static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleAgeSorter;
59static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleProfitThisYearSorter;
60static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleProfitLastYearSorter;
61static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleCargoSorter;
62static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleReliabilitySorter;
63static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleMaxSpeedSorter;
64static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleModelSorter;
65static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleValueSorter;
66static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleLengthSorter;
67static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleTimeToLiveSorter;
68static BaseVehicleListWindow::VehicleIndividualSortFunction VehicleTimetableDelaySorter;
69static BaseVehicleListWindow::VehicleGroupSortFunction VehicleGroupLengthSorter;
70static BaseVehicleListWindow::VehicleGroupSortFunction VehicleGroupTotalProfitThisYearSorter;
71static BaseVehicleListWindow::VehicleGroupSortFunction VehicleGroupTotalProfitLastYearSorter;
72static BaseVehicleListWindow::VehicleGroupSortFunction VehicleGroupAverageProfitThisYearSorter;
73static BaseVehicleListWindow::VehicleGroupSortFunction VehicleGroupAverageProfitLastYearSorter;
74
76template <BaseVehicleListWindow::VehicleIndividualSortFunction func>
78{
79 return func(*(a.vehicles_begin), *(b.vehicles_begin));
80}
81
82const std::initializer_list<BaseVehicleListWindow::VehicleGroupSortFunction * const> BaseVehicleListWindow::vehicle_group_none_sorter_funcs = {
96};
97
98const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_none_sorter_names_calendar = {
99 STR_SORT_BY_NUMBER,
100 STR_SORT_BY_NAME,
101 STR_SORT_BY_AGE,
102 STR_SORT_BY_PROFIT_THIS_YEAR,
103 STR_SORT_BY_PROFIT_LAST_YEAR,
104 STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,
105 STR_SORT_BY_RELIABILITY,
106 STR_SORT_BY_MAX_SPEED,
107 STR_SORT_BY_MODEL,
108 STR_SORT_BY_VALUE,
109 STR_SORT_BY_LENGTH,
110 STR_SORT_BY_LIFE_TIME,
111 STR_SORT_BY_TIMETABLE_DELAY,
112};
113
114const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_none_sorter_names_wallclock = {
115 STR_SORT_BY_NUMBER,
116 STR_SORT_BY_NAME,
117 STR_SORT_BY_AGE,
118 STR_SORT_BY_PROFIT_THIS_PERIOD,
119 STR_SORT_BY_PROFIT_LAST_PERIOD,
120 STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,
121 STR_SORT_BY_RELIABILITY,
122 STR_SORT_BY_MAX_SPEED,
123 STR_SORT_BY_MODEL,
124 STR_SORT_BY_VALUE,
125 STR_SORT_BY_LENGTH,
126 STR_SORT_BY_LIFE_TIME,
127 STR_SORT_BY_TIMETABLE_DELAY,
128};
129
130const std::initializer_list<BaseVehicleListWindow::VehicleGroupSortFunction * const> BaseVehicleListWindow::vehicle_group_shared_orders_sorter_funcs = {
131 &VehicleGroupLengthSorter,
132 &VehicleGroupTotalProfitThisYearSorter,
133 &VehicleGroupTotalProfitLastYearSorter,
134 &VehicleGroupAverageProfitThisYearSorter,
135 &VehicleGroupAverageProfitLastYearSorter,
136};
137
138const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_shared_orders_sorter_names_calendar = {
139 STR_SORT_BY_NUM_VEHICLES,
140 STR_SORT_BY_TOTAL_PROFIT_THIS_YEAR,
141 STR_SORT_BY_TOTAL_PROFIT_LAST_YEAR,
142 STR_SORT_BY_AVERAGE_PROFIT_THIS_YEAR,
143 STR_SORT_BY_AVERAGE_PROFIT_LAST_YEAR,
144};
145
146const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_shared_orders_sorter_names_wallclock = {
147 STR_SORT_BY_NUM_VEHICLES,
148 STR_SORT_BY_TOTAL_PROFIT_THIS_PERIOD,
149 STR_SORT_BY_TOTAL_PROFIT_LAST_PERIOD,
150 STR_SORT_BY_AVERAGE_PROFIT_THIS_PERIOD,
151 STR_SORT_BY_AVERAGE_PROFIT_LAST_PERIOD,
152};
153
154const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_by_names = {
155 STR_GROUP_BY_NONE,
156 STR_GROUP_BY_SHARED_ORDERS,
157};
158
159const StringID BaseVehicleListWindow::vehicle_depot_name[] = {
160 STR_VEHICLE_LIST_SEND_TRAIN_TO_DEPOT,
161 STR_VEHICLE_LIST_SEND_ROAD_VEHICLE_TO_DEPOT,
162 STR_VEHICLE_LIST_SEND_SHIP_TO_DEPOT,
163 STR_VEHICLE_LIST_SEND_AIRCRAFT_TO_HANGAR
164};
165
166BaseVehicleListWindow::BaseVehicleListWindow(WindowDesc &desc, const VehicleListIdentifier &vli) : Window(desc), vli(vli)
167{
168 this->vehicle_sel = VehicleID::Invalid();
169 this->grouping = _grouping[vli.type][vli.vtype];
170 this->UpdateSortingFromGrouping();
171}
172
173std::span<const StringID> BaseVehicleListWindow::GetVehicleSorterNames() const
174{
175 switch (this->grouping) {
176 case GB_NONE:
177 return TimerGameEconomy::UsingWallclockUnits() ? vehicle_group_none_sorter_names_wallclock : vehicle_group_none_sorter_names_calendar;
178 case GB_SHARED_ORDERS:
179 return TimerGameEconomy::UsingWallclockUnits() ? vehicle_group_shared_orders_sorter_names_wallclock : vehicle_group_shared_orders_sorter_names_calendar;
180 default:
181 NOT_REACHED();
182 }
183}
184
191{
192 if (number >= 10000) return 5;
193 if (number >= 1000) return 4;
194 if (number >= 100) return 3;
195
196 /*
197 * When the smallest unit number is less than 10, it is
198 * quite likely that it will expand to become more than
199 * 10 quite soon.
200 */
201 return 2;
202}
203
210{
211 uint unitnumber = 0;
212 for (const Vehicle *v : vehicles) {
213 unitnumber = std::max<uint>(unitnumber, v->unitnumber);
214 }
215
216 return CountDigitsForAllocatingSpace(unitnumber);
217}
218
219void BaseVehicleListWindow::BuildVehicleList()
220{
221 if (!this->vehgroups.NeedRebuild()) return;
222
223 Debug(misc, 3, "Building vehicle list type {} for company {} given index {}", this->vli.type, this->vli.company, this->vli.index);
224
225 this->vehgroups.clear();
226
227 GenerateVehicleSortList(&this->vehicles, this->vli);
228
229 CargoTypes used = 0;
230 for (const Vehicle *v : this->vehicles) {
231 for (const Vehicle *u = v; u != nullptr; u = u->Next()) {
232 if (u->cargo_cap > 0) SetBit(used, u->cargo_type);
233 }
234 }
235 this->used_cargoes = used;
236
237 if (this->grouping == GB_NONE) {
238 uint max_unitnumber = 0;
239 for (auto it = this->vehicles.begin(); it != this->vehicles.end(); ++it) {
240 this->vehgroups.emplace_back(it, it + 1);
241
242 max_unitnumber = std::max<uint>(max_unitnumber, (*it)->unitnumber);
243 }
244 this->unitnumber_digits = CountDigitsForAllocatingSpace(max_unitnumber);
245 } else {
246 /* Sort by the primary vehicle; we just want all vehicles that share the same orders to form a contiguous range. */
247 std::stable_sort(this->vehicles.begin(), this->vehicles.end(), [](const Vehicle * const &u, const Vehicle * const &v) {
248 return u->FirstShared() < v->FirstShared();
249 });
250
251 uint max_num_vehicles = 0;
252
253 VehicleList::const_iterator begin = this->vehicles.begin();
254 while (begin != this->vehicles.end()) {
255 VehicleList::const_iterator end = std::find_if_not(begin, this->vehicles.cend(), [first_shared = (*begin)->FirstShared()](const Vehicle * const &v) {
256 return v->FirstShared() == first_shared;
257 });
258
259 this->vehgroups.emplace_back(begin, end);
260
261 max_num_vehicles = std::max<uint>(max_num_vehicles, static_cast<uint>(end - begin));
262
263 begin = end;
264 }
265
266 this->unitnumber_digits = CountDigitsForAllocatingSpace(max_num_vehicles);
267 }
268 this->FilterVehicleList();
269
270 this->vehgroups.RebuildDone();
271 this->vscroll->SetCount(this->vehgroups.size());
272}
273
281static bool CargoFilterSingle(const Vehicle *v, const CargoType cargo_type)
282{
283 if (cargo_type == CargoFilterCriteria::CF_ANY) {
284 return true;
285 } else if (cargo_type == CargoFilterCriteria::CF_NONE) {
286 for (const Vehicle *w = v; w != nullptr; w = w->Next()) {
287 if (w->cargo_cap > 0) {
288 return false;
289 }
290 }
291 return true;
292 } else if (cargo_type == CargoFilterCriteria::CF_FREIGHT) {
293 bool have_capacity = false;
294 for (const Vehicle *w = v; w != nullptr; w = w->Next()) {
295 if (w->cargo_cap > 0) {
296 if (IsCargoInClass(w->cargo_type, CargoClass::Passengers)) {
297 return false;
298 } else {
299 have_capacity = true;
300 }
301 }
302 }
303 return have_capacity;
304 } else {
305 for (const Vehicle *w = v; w != nullptr; w = w->Next()) {
306 if (w->cargo_cap > 0 && w->cargo_type == cargo_type) {
307 return true;
308 }
309 }
310 return false;
311 }
312}
313
321static bool CargoFilter(const GUIVehicleGroup *vehgroup, const CargoType cargo_type)
322{
323 auto it = vehgroup->vehicles_begin;
324
325 /* Check if any vehicle in the group matches; if so, the whole group does. */
326 for (; it != vehgroup->vehicles_end; it++) {
327 if (CargoFilterSingle(*it, cargo_type)) return true;
328 }
329
330 return false;
331}
332
338{
340}
341
349void AddCargoIconOverlay(std::vector<CargoIconOverlay> &overlays, int x, int width, const Vehicle *v)
350{
351 bool rtl = _current_text_dir == TD_RTL;
352 if (!v->IsArticulatedPart() || v->cargo_type != v->Previous()->cargo_type) {
353 /* Add new overlay slot. */
354 overlays.emplace_back(rtl ? x - width : x, rtl ? x : x + width, v->cargo_type, v->cargo_cap);
355 } else {
356 /* This is an articulated part with the same cargo type, adjust left or right of last overlay slot. */
357 if (rtl) {
358 overlays.back().left -= width;
359 } else {
360 overlays.back().right += width;
361 }
362 overlays.back().cargo_cap += v->cargo_cap;
363 }
364}
365
372void DrawCargoIconOverlay(int x, int y, CargoType cargo_type)
373{
374 if (!ShowCargoIconOverlay()) return;
375 if (!IsValidCargoType(cargo_type)) return;
376
377 const CargoSpec *cs = CargoSpec::Get(cargo_type);
378
379 SpriteID spr = cs->GetCargoIcon();
380 if (spr == 0) return;
381
382 Dimension d = GetSpriteSize(spr);
383 d.width /= 2;
384 d.height /= 2;
385 int one = ScaleGUITrad(1);
386
387 /* Draw the cargo icon in black shifted 4 times to create the outline. */
388 DrawSprite(spr, PALETTE_ALL_BLACK, x - d.width - one, y - d.height);
389 DrawSprite(spr, PALETTE_ALL_BLACK, x - d.width + one, y - d.height);
390 DrawSprite(spr, PALETTE_ALL_BLACK, x - d.width, y - d.height - one);
391 DrawSprite(spr, PALETTE_ALL_BLACK, x - d.width, y - d.height + one);
392 /* Draw the cargo icon normally. */
393 DrawSprite(spr, PAL_NONE, x - d.width, y - d.height);
394}
395
401void DrawCargoIconOverlays(std::span<const CargoIconOverlay> overlays, int y)
402{
403 for (const auto &cio : overlays) {
404 if (cio.cargo_cap == 0) continue;
405 DrawCargoIconOverlay((cio.left + cio.right) / 2, y, cio.cargo_type);
406 }
407}
408
409static GUIVehicleGroupList::FilterFunction * const _vehicle_group_filter_funcs[] = {
411};
412
418{
419 if (this->cargo_filter_criteria != cargo_type) {
420 this->cargo_filter_criteria = cargo_type;
421 /* Deactivate filter if criteria is 'Show All', activate it otherwise. */
422 this->vehgroups.SetFilterState(this->cargo_filter_criteria != CargoFilterCriteria::CF_ANY);
423 this->vehgroups.SetFilterType(0);
424 this->vehgroups.ForceRebuild();
425 }
426}
427
432{
434 this->vehgroups.SetFilterFuncs(_vehicle_group_filter_funcs);
435 this->vehgroups.SetFilterState(this->cargo_filter_criteria != CargoFilterCriteria::CF_ANY);
436}
437
442{
443 this->vehgroups.Filter(this->cargo_filter_criteria);
444 if (this->vehicles.empty()) {
445 /* No vehicle passed through the filter, invalidate the previously selected vehicle */
446 this->vehicle_sel = VehicleID::Invalid();
447 } else if (this->vehicle_sel != VehicleID::Invalid() && std::ranges::find(this->vehicles, Vehicle::Get(this->vehicle_sel)) == this->vehicles.end()) { // previously selected engine didn't pass the filter, remove selection
448 this->vehicle_sel = VehicleID::Invalid();
449 }
450}
451
459Dimension BaseVehicleListWindow::GetActionDropdownSize(bool show_autoreplace, bool show_group, bool show_create)
460{
461 Dimension d = {0, 0};
462
463 if (show_autoreplace) d = maxdim(d, GetStringBoundingBox(STR_VEHICLE_LIST_REPLACE_VEHICLES));
464 d = maxdim(d, GetStringBoundingBox(STR_VEHICLE_LIST_SEND_FOR_SERVICING));
465 d = maxdim(d, GetStringBoundingBox(this->vehicle_depot_name[this->vli.vtype]));
466
467 if (show_group) {
468 d = maxdim(d, GetStringBoundingBox(STR_GROUP_ADD_SHARED_VEHICLE));
469 d = maxdim(d, GetStringBoundingBox(STR_GROUP_REMOVE_ALL_VEHICLES));
470 } else if (show_create) {
471 d = maxdim(d, GetStringBoundingBox(STR_VEHICLE_LIST_CREATE_GROUP));
472 }
473
474 return d;
475}
476
478{
479 this->order_arrow_width = std::max(GetStringBoundingBox(STR_JUST_LEFT_ARROW, FS_SMALL).width, GetStringBoundingBox(STR_JUST_RIGHT_ARROW, FS_SMALL).width);
480 this->SetCargoFilterArray();
481}
482
483StringID BaseVehicleListWindow::GetCargoFilterLabel(CargoType cargo_type) const
484{
485 switch (cargo_type) {
486 case CargoFilterCriteria::CF_ANY: return STR_CARGO_TYPE_FILTER_ALL;
487 case CargoFilterCriteria::CF_FREIGHT: return STR_CARGO_TYPE_FILTER_FREIGHT;
488 case CargoFilterCriteria::CF_NONE: return STR_CARGO_TYPE_FILTER_NONE;
489 default: return CargoSpec::Get(cargo_type)->name;
490 }
491}
492
499{
500 DropDownList list;
501
502 /* Add item for disabling filtering. */
503 list.push_back(MakeDropDownListStringItem(this->GetCargoFilterLabel(CargoFilterCriteria::CF_ANY), CargoFilterCriteria::CF_ANY));
504 /* Add item for freight (i.e. vehicles with cargo capacity and with no passenger capacity). */
505 list.push_back(MakeDropDownListStringItem(this->GetCargoFilterLabel(CargoFilterCriteria::CF_FREIGHT), CargoFilterCriteria::CF_FREIGHT));
506 /* Add item for vehicles not carrying anything, e.g. train engines. */
507 list.push_back(MakeDropDownListStringItem(this->GetCargoFilterLabel(CargoFilterCriteria::CF_NONE), CargoFilterCriteria::CF_NONE));
508
509 /* Add cargos */
511 for (const CargoSpec *cs : _sorted_cargo_specs) {
512 if (!full && !HasBit(this->used_cargoes, cs->Index())) continue;
513 list.push_back(MakeDropDownListIconItem(d, cs->GetCargoIcon(), PAL_NONE, cs->name, cs->Index(), false, !HasBit(this->used_cargoes, cs->Index())));
514 }
515
516 return list;
517}
518
526DropDownList BaseVehicleListWindow::BuildActionDropdownList(bool show_autoreplace, bool show_group, bool show_create)
527{
528 DropDownList list;
529
530 /* Autoreplace actions. */
531 if (show_autoreplace) {
532 list.push_back(MakeDropDownListStringItem(STR_VEHICLE_LIST_REPLACE_VEHICLES, ADI_REPLACE));
533 list.push_back(MakeDropDownListDividerItem());
534 }
535
536 /* Group actions. */
537 if (show_group) {
538 list.push_back(MakeDropDownListStringItem(STR_GROUP_ADD_SHARED_VEHICLE, ADI_ADD_SHARED));
539 list.push_back(MakeDropDownListStringItem(STR_GROUP_REMOVE_ALL_VEHICLES, ADI_REMOVE_ALL));
540 list.push_back(MakeDropDownListDividerItem());
541 } else if (show_create) {
542 list.push_back(MakeDropDownListStringItem(STR_VEHICLE_LIST_CREATE_GROUP, ADI_CREATE_GROUP));
543 list.push_back(MakeDropDownListDividerItem());
544 }
545
546 /* Depot actions. */
547 list.push_back(MakeDropDownListStringItem(STR_VEHICLE_LIST_SEND_FOR_SERVICING, ADI_SERVICE));
548 list.push_back(MakeDropDownListStringItem(this->vehicle_depot_name[this->vli.vtype], ADI_DEPOT));
549
550 return list;
551}
552
553/* cached values for VehicleNameSorter to spare many GetString() calls */
554static const Vehicle *_last_vehicle[2] = { nullptr, nullptr };
555
556void BaseVehicleListWindow::SortVehicleList()
557{
558 if (this->vehgroups.Sort()) return;
559
560 /* invalidate cached values for name sorter - vehicle names could change */
561 _last_vehicle[0] = _last_vehicle[1] = nullptr;
562}
563
564void DepotSortList(VehicleList *list)
565{
566 if (list->size() < 2) return;
567 std::sort(list->begin(), list->end(), &VehicleNumberSorter);
568}
569
571static void DrawVehicleProfitButton(TimerGameEconomy::Date age, Money display_profit_last_year, uint num_vehicles, int x, int y)
572{
573 SpriteID spr;
574
575 /* draw profit-based coloured icons */
576 if (age <= VEHICLE_PROFIT_MIN_AGE) {
577 spr = SPR_PROFIT_NA;
578 } else if (display_profit_last_year < 0) {
579 spr = SPR_PROFIT_NEGATIVE;
580 } else if (display_profit_last_year < VEHICLE_PROFIT_THRESHOLD * num_vehicles) {
581 spr = SPR_PROFIT_SOME;
582 } else {
583 spr = SPR_PROFIT_LOT;
584 }
585 DrawSprite(spr, PAL_NONE, x, y);
586}
587
589static const uint MAX_REFIT_CYCLE = 256;
590
600uint8_t GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoType dest_cargo_type)
601{
602 v_from = v_from->GetFirstEnginePart();
603 v_for = v_for->GetFirstEnginePart();
604
605 /* Create a list of subtypes used by the various parts of v_for */
606 static std::vector<StringID> subtypes;
607 subtypes.clear();
608 for (; v_from != nullptr; v_from = v_from->HasArticulatedPart() ? v_from->GetNextArticulatedPart() : nullptr) {
609 const Engine *e_from = v_from->GetEngine();
610 if (!e_from->CanCarryCargo() || !e_from->info.callback_mask.Test(VehicleCallbackMask::CargoSuffix)) continue;
611 include(subtypes, GetCargoSubtypeText(v_from));
612 }
613
614 uint8_t ret_refit_cyc = 0;
615 bool success = false;
616 if (!subtypes.empty()) {
617 /* Check whether any articulated part is refittable to 'dest_cargo_type' with a subtype listed in 'subtypes' */
618 for (Vehicle *v = v_for; v != nullptr; v = v->HasArticulatedPart() ? v->GetNextArticulatedPart() : nullptr) {
619 const Engine *e = v->GetEngine();
620 if (!e->CanCarryCargo() || !e->info.callback_mask.Test(VehicleCallbackMask::CargoSuffix)) continue;
621 if (!HasBit(e->info.refit_mask, dest_cargo_type) && v->cargo_type != dest_cargo_type) continue;
622
623 CargoType old_cargo_type = v->cargo_type;
624 uint8_t old_cargo_subtype = v->cargo_subtype;
625
626 /* Set the 'destination' cargo */
627 v->cargo_type = dest_cargo_type;
628
629 /* Cycle through the refits */
630 for (uint refit_cyc = 0; refit_cyc < MAX_REFIT_CYCLE; refit_cyc++) {
631 v->cargo_subtype = refit_cyc;
632
633 /* Make sure we don't pick up anything cached. */
634 v->First()->InvalidateNewGRFCache();
635 v->InvalidateNewGRFCache();
636
637 StringID subtype = GetCargoSubtypeText(v);
638 if (subtype == STR_EMPTY) break;
639
640 if (std::ranges::find(subtypes, subtype) == subtypes.end()) continue;
641
642 /* We found something matching. */
643 ret_refit_cyc = refit_cyc;
644 success = true;
645 break;
646 }
647
648 /* Reset the vehicle's cargo type */
649 v->cargo_type = old_cargo_type;
650 v->cargo_subtype = old_cargo_subtype;
651
652 /* Make sure we don't taint the vehicle. */
653 v->First()->InvalidateNewGRFCache();
654 v->InvalidateNewGRFCache();
655
656 if (success) break;
657 }
658 }
659
660 return ret_refit_cyc;
661}
662
666 uint8_t subtype;
668
674 inline bool operator == (const RefitOption &other) const
675 {
676 return other.cargo == this->cargo && other.string == this->string;
677 }
678};
679
680using RefitOptions = std::map<CargoType, std::vector<RefitOption>, CargoTypeComparator>;
681
691static void DrawVehicleRefitWindow(const RefitOptions &refits, const RefitOption *sel, uint pos, uint rows, uint delta, const Rect &r)
692{
693 Rect ir = r.Shrink(WidgetDimensions::scaled.matrix);
694 uint current = 0;
695
696 bool rtl = _current_text_dir == TD_RTL;
697 uint iconwidth = std::max(GetSpriteSize(SPR_CIRCLE_FOLDED).width, GetSpriteSize(SPR_CIRCLE_UNFOLDED).width);
698 uint iconheight = GetSpriteSize(SPR_CIRCLE_FOLDED).height;
699 PixelColour linecolour = GetColourGradient(COLOUR_ORANGE, SHADE_NORMAL);
700
701 int iconleft = rtl ? ir.right - iconwidth : ir.left;
702 int iconcenter = rtl ? ir.right - iconwidth / 2 : ir.left + iconwidth / 2;
703 int iconinner = rtl ? ir.right - iconwidth : ir.left + iconwidth;
704
705 Rect tr = ir.Indent(iconwidth + WidgetDimensions::scaled.hsep_wide, rtl);
706
707 /* Draw the list of subtypes for each cargo, and find the selected refit option (by its position). */
708 for (const auto &pair : refits) {
709 bool has_subtypes = pair.second.size() > 1;
710 for (const RefitOption &refit : pair.second) {
711 if (current >= pos + rows) break;
712
713 /* Hide subtypes if selected cargo type does not match */
714 if ((sel == nullptr || sel->cargo != refit.cargo) && refit.subtype != UINT8_MAX) continue;
715
716 /* Refit options with a position smaller than pos don't have to be drawn. */
717 if (current < pos) {
718 current++;
719 continue;
720 }
721
722 if (has_subtypes) {
723 if (refit.subtype != UINT8_MAX) {
724 /* Draw tree lines */
725 int ycenter = tr.top + GetCharacterHeight(FS_NORMAL) / 2;
726 GfxDrawLine(iconcenter, tr.top - WidgetDimensions::scaled.matrix.top, iconcenter, (&refit == &pair.second.back()) ? ycenter : tr.top - WidgetDimensions::scaled.matrix.top + delta - 1, linecolour);
727 GfxDrawLine(iconcenter, ycenter, iconinner, ycenter, linecolour);
728 } else {
729 /* Draw expand/collapse icon */
730 DrawSprite((sel != nullptr && sel->cargo == refit.cargo) ? SPR_CIRCLE_UNFOLDED : SPR_CIRCLE_FOLDED, PAL_NONE, iconleft, tr.top + (GetCharacterHeight(FS_NORMAL) - iconheight) / 2);
731 }
732 }
733
734 TextColour colour = (sel != nullptr && sel->cargo == refit.cargo && sel->subtype == refit.subtype) ? TC_WHITE : TC_BLACK;
735 /* Get the cargo name. */
736 DrawString(tr, GetString(STR_JUST_STRING_STRING, CargoSpec::Get(refit.cargo)->name, refit.string), colour);
737
738 tr.top += delta;
739 current++;
740 }
741 }
742}
743
745struct RefitWindow : public Window {
746 const RefitOption *selected_refit = nullptr;
750 Scrollbar *vscroll = nullptr;
751 Scrollbar *hscroll = nullptr;
753 int sprite_left = 0;
754 int sprite_right = 0;
755 uint vehicle_margin = 0;
756 int click_x = 0;
758 uint8_t num_vehicles = 0;
759 bool auto_refit = false;
760
765 {
766 /* Store the currently selected RefitOption. */
767 std::optional<RefitOption> current_refit_option;
768 if (this->selected_refit != nullptr) current_refit_option = *(this->selected_refit);
769 this->selected_refit = nullptr;
770
771 this->refit_list.clear();
773
774 /* Check only the selected vehicles. */
775 VehicleSet vehicles_to_refit;
776 GetVehicleSet(vehicles_to_refit, Vehicle::Get(this->selected_vehicle), this->num_vehicles);
777
778 do {
779 if (v->type == VEH_TRAIN && std::ranges::find(vehicles_to_refit, v->index) == vehicles_to_refit.end()) continue;
780 const Engine *e = v->GetEngine();
781 CargoTypes cmask = e->info.refit_mask;
782 VehicleCallbackMasks callback_mask = e->info.callback_mask;
783
784 /* Skip this engine if it does not carry anything */
785 if (!e->CanCarryCargo()) continue;
786 /* Skip this engine if we build the list for auto-refitting and engine doesn't allow it. */
787 if (this->auto_refit && !e->info.misc_flags.Test(EngineMiscFlag::AutoRefit)) continue;
788
789 /* Loop through all cargoes in the refit mask */
790 for (const auto &cs : _sorted_cargo_specs) {
791 CargoType cargo_type = cs->Index();
792 /* Skip cargo type if it's not listed */
793 if (!HasBit(cmask, cargo_type)) continue;
794
795 auto &list = this->refit_list[cargo_type];
796 bool first_vehicle = list.empty();
797 if (first_vehicle) {
798 /* Keeping the current subtype is always an option. It also serves as the option in case of no subtypes */
799 list.emplace_back(cargo_type, UINT8_MAX, STR_EMPTY);
800 }
801
802 /* Check the vehicle's callback mask for cargo suffixes.
803 * This is not supported for ordered refits, since subtypes only have a meaning
804 * for a specific vehicle at a specific point in time, which conflicts with shared orders,
805 * autoreplace, autorenew, clone, order restoration, ... */
806 if (this->order == INVALID_VEH_ORDER_ID && callback_mask.Test(VehicleCallbackMask::CargoSuffix)) {
807 /* Make a note of the original cargo type. It has to be
808 * changed to test the cargo & subtype... */
809 CargoType temp_cargo = v->cargo_type;
810 uint8_t temp_subtype = v->cargo_subtype;
811
812 v->cargo_type = cargo_type;
813
814 for (uint refit_cyc = 0; refit_cyc < MAX_REFIT_CYCLE; refit_cyc++) {
815 v->cargo_subtype = refit_cyc;
816
817 /* Make sure we don't pick up anything cached. */
820
821 StringID subtype = GetCargoSubtypeText(v);
822
823 if (first_vehicle) {
824 /* Append new subtype (don't add duplicates though) */
825 if (subtype == STR_EMPTY) break;
826
827 RefitOption option{cargo_type, static_cast<uint8_t>(refit_cyc), subtype};
828 include(list, option);
829 } else {
830 /* Intersect the subtypes of earlier vehicles with the subtypes of this vehicle */
831 if (subtype == STR_EMPTY) {
832 /* No more subtypes for this vehicle, delete all subtypes >= refit_cyc */
833 /* UINT8_MAX item is in front, other subtypes are sorted. So just truncate the list in the right spot */
834 for (uint i = 1; i < list.size(); i++) {
835 if (list[i].subtype >= refit_cyc) {
836 list.erase(list.begin() + i, list.end());
837 break;
838 }
839 }
840 break;
841 } else {
842 /* Check whether the subtype matches with the subtype of earlier vehicles. */
843 uint pos = 1;
844 while (pos < list.size() && list[pos].subtype != refit_cyc) pos++;
845 if (pos < list.size() && list[pos].string != subtype) {
846 /* String mismatch, remove item keeping the order */
847 list.erase(list.begin() + pos);
848 }
849 }
850 }
851 }
852
853 /* Reset the vehicle's cargo type */
854 v->cargo_type = temp_cargo;
855 v->cargo_subtype = temp_subtype;
856
857 /* And make sure we haven't tainted the cache */
860 }
861 }
862 } while (v->IsGroundVehicle() && (v = v->Next()) != nullptr);
863
864 /* Restore the previously selected RefitOption. */
865 if (current_refit_option.has_value()) {
866 for (const auto &pair : this->refit_list) {
867 for (const auto &refit : pair.second) {
868 if (refit.cargo == current_refit_option->cargo && refit.subtype == current_refit_option->subtype) {
869 this->selected_refit = &refit;
870 break;
871 }
872 }
873 if (this->selected_refit != nullptr) break;
874 }
875 }
876
877 this->SetWidgetDisabledState(WID_VR_REFIT, this->selected_refit == nullptr);
878 }
879
884 {
885 size_t scroll_row = 0;
886 size_t rows = 0;
887 CargoType cargo = this->selected_refit == nullptr ? INVALID_CARGO : this->selected_refit->cargo;
888
889 for (const auto &pair : this->refit_list) {
890 if (pair.first == cargo) {
891 /* selected_refit points to an element in the vector so no need to search for it. */
892 scroll_row = rows + (this->selected_refit - pair.second.data());
893 rows += pair.second.size();
894 } else {
895 rows++; /* Unselected cargo type is collapsed into one row. */
896 }
897 }
898
899 this->vscroll->SetCount(rows);
900 this->vscroll->ScrollTowards(static_cast<int>(scroll_row));
901 }
902
907 void SetSelection(uint click_row)
908 {
909 uint row = 0;
910
911 for (const auto &pair : refit_list) {
912 for (const RefitOption &refit : pair.second) {
913 if (row == click_row) {
914 this->selected_refit = &refit;
915 return;
916 }
917 row++;
918 /* If this cargo type is not already selected then its subtypes are not visible, so skip the rest. */
919 if (this->selected_refit == nullptr || this->selected_refit->cargo != refit.cargo) break;
920 }
921 }
922
923 /* No selection made */
924 this->selected_refit = nullptr;
925 }
926
927 RefitWindow(WindowDesc &desc, const Vehicle *v, VehicleOrderID order, bool auto_refit) : Window(desc)
928 {
929 this->auto_refit = auto_refit;
930 this->order = order;
931 this->CreateNestedTree();
932
933 this->vscroll = this->GetScrollbar(WID_VR_SCROLLBAR);
934 this->hscroll = (v->IsGroundVehicle() ? this->GetScrollbar(WID_VR_HSCROLLBAR) : nullptr);
935 this->GetWidget<NWidgetCore>(WID_VR_SELECT_HEADER)->SetToolTip(STR_REFIT_TRAIN_LIST_TOOLTIP + v->type);
936 this->GetWidget<NWidgetCore>(WID_VR_MATRIX)->SetToolTip(STR_REFIT_TRAIN_LIST_TOOLTIP + v->type);
938 nwi->SetStringTip(STR_REFIT_TRAIN_REFIT_BUTTON + v->type, STR_REFIT_TRAIN_REFIT_TOOLTIP + v->type);
940 this->GetWidget<NWidgetCore>(WID_VR_VEHICLE_PANEL_DISPLAY)->SetToolTip((v->type == VEH_TRAIN) ? STR_REFIT_SELECT_VEHICLES_TOOLTIP : STR_NULL);
941
942 this->FinishInitNested(v->index);
943 this->owner = v->owner;
944
945 this->SetWidgetDisabledState(WID_VR_REFIT, this->selected_refit == nullptr);
946 }
947
948 void OnInit() override
949 {
950 /* (Re)build the refit list */
952 }
953
954 void OnPaint() override
955 {
956 /* Determine amount of items for scroller. */
957 if (this->hscroll != nullptr) this->hscroll->SetCount(this->vehicle_width);
958
959 /* Calculate sprite position. */
961 int sprite_width = std::max(0, ((int)vehicle_panel_display->current_x - this->vehicle_width) / 2);
962 this->sprite_left = vehicle_panel_display->pos_x;
963 this->sprite_right = vehicle_panel_display->pos_x + vehicle_panel_display->current_x - 1;
964 if (_current_text_dir == TD_RTL) {
965 this->sprite_right -= sprite_width;
966 this->vehicle_margin = vehicle_panel_display->current_x - sprite_right;
967 } else {
968 this->sprite_left += sprite_width;
969 this->vehicle_margin = sprite_left;
970 }
971
972 this->DrawWidgets();
973 }
974
975 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
976 {
977 switch (widget) {
978 case WID_VR_MATRIX:
979 fill.height = resize.height = GetCharacterHeight(FS_NORMAL) + padding.height;
980 size.height = resize.height * 8;
981 break;
982
984 size.height = ScaleGUITrad(GetVehicleHeight(Vehicle::Get(this->window_number)->type));
985 break;
986
987 case WID_VR_INFO:
988 size.width = this->information_width + padding.height;
989 break;
990 }
991 }
992
993 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
994 {
995 if (widget == WID_VR_CAPTION) return GetString(STR_REFIT_CAPTION, Vehicle::Get(this->window_number)->index);
996
997 return this->Window::GetWidgetString(widget, stringid);
998 }
999
1006 std::string GetCapacityString(const RefitOption &option) const
1007 {
1009 auto [cost, refit_capacity, mail_capacity, cargo_capacities] = Command<Commands::RefitVehicle>::Do(DoCommandFlag::QueryCost, this->selected_vehicle, option.cargo, option.subtype, this->auto_refit, false, this->num_vehicles);
1010
1011 if (cost.Failed()) return {};
1012
1013 Money money = cost.GetCost();
1014 if (mail_capacity > 0) {
1015 if (this->order != INVALID_VEH_ORDER_ID) {
1016 /* No predictable cost */
1017 return GetString(STR_PURCHASE_INFO_AIRCRAFT_CAPACITY, option.cargo, refit_capacity, GetCargoTypeByLabel(CT_MAIL), mail_capacity);
1018 }
1019
1020 if (money <= 0) {
1021 return GetString(STR_REFIT_NEW_CAPACITY_INCOME_FROM_AIRCRAFT_REFIT, option.cargo, refit_capacity, GetCargoTypeByLabel(CT_MAIL), mail_capacity, -money);
1022 }
1023
1024 return GetString(STR_REFIT_NEW_CAPACITY_COST_OF_AIRCRAFT_REFIT, option.cargo, refit_capacity, GetCargoTypeByLabel(CT_MAIL), mail_capacity, money);
1025 }
1026
1027 if (this->order != INVALID_VEH_ORDER_ID) {
1028 /* No predictable cost */
1029 return GetString(STR_PURCHASE_INFO_CAPACITY, option.cargo, refit_capacity, STR_EMPTY);
1030 }
1031
1032 if (money <= 0) {
1033 return GetString(STR_REFIT_NEW_CAPACITY_INCOME_FROM_REFIT, option.cargo, refit_capacity, -money);
1034 }
1035
1036 return GetString(STR_REFIT_NEW_CAPACITY_COST_OF_REFIT, option.cargo, refit_capacity, money);
1037 }
1038
1039 void DrawWidget(const Rect &r, WidgetID widget) const override
1040 {
1041 switch (widget) {
1044 DrawVehicleImage(v, r.WithX(this->sprite_left, this->sprite_right),
1045 VehicleID::Invalid(), EIT_IN_DETAILS, this->hscroll != nullptr ? this->hscroll->GetPosition() : 0);
1046
1047 /* Highlight selected vehicles. */
1048 if (this->order != INVALID_VEH_ORDER_ID) break;
1049 int x = 0;
1050 switch (v->type) {
1051 case VEH_TRAIN: {
1052 VehicleSet vehicles_to_refit;
1053 GetVehicleSet(vehicles_to_refit, Vehicle::Get(this->selected_vehicle), this->num_vehicles);
1054
1055 int left = INT32_MIN;
1056 int width = 0;
1057
1058 /* Determine top & bottom position of the highlight.*/
1059 const int height = ScaleSpriteTrad(12);
1060 const int highlight_top = CentreBounds(r.top, r.bottom, height);
1061 const int highlight_bottom = highlight_top + height - 1;
1062
1063 for (Train *u = Train::From(v); u != nullptr; u = u->Next()) {
1064 /* Start checking. */
1065 const bool contained = std::ranges::find(vehicles_to_refit, u->index) != vehicles_to_refit.end();
1066 if (contained && left == INT32_MIN) {
1067 left = x - this->hscroll->GetPosition() + r.left + this->vehicle_margin;
1068 width = 0;
1069 }
1070
1071 /* Draw a selection. */
1072 if ((!contained || u->Next() == nullptr) && left != INT32_MIN) {
1073 if (u->Next() == nullptr && contained) {
1074 int current_width = u->GetDisplayImageWidth();
1075 width += current_width;
1076 x += current_width;
1077 }
1078
1079 int right = Clamp(left + width, 0, r.right);
1080 left = std::max(0, left);
1081
1082 if (_current_text_dir == TD_RTL) {
1083 right = r.Width() - left;
1084 left = right - width;
1085 }
1086
1087 if (left != right) {
1088 Rect hr = {left, highlight_top, right, highlight_bottom};
1090 }
1091
1092 left = INT32_MIN;
1093 }
1094
1095 int current_width = u->GetDisplayImageWidth();
1096 width += current_width;
1097 x += current_width;
1098 }
1099 break;
1100 }
1101
1102 default: break;
1103 }
1104 break;
1105 }
1106
1107 case WID_VR_MATRIX:
1108 DrawVehicleRefitWindow(this->refit_list, this->selected_refit, this->vscroll->GetPosition(), this->vscroll->GetCapacity(), this->resize.step_height, r);
1109 break;
1110
1111 case WID_VR_INFO:
1112 if (this->selected_refit != nullptr) {
1113 std::string string = this->GetCapacityString(*this->selected_refit);
1114 if (!string.empty()) {
1116 }
1117 }
1118 break;
1119 }
1120 }
1121
1127 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1128 {
1129 switch (data) {
1130 case VIWD_AUTOREPLACE: // Autoreplace replaced the vehicle; selected_vehicle became invalid.
1131 case VIWD_CONSIST_CHANGED: { // The consist has changed; rebuild the entire list.
1132 /* Clear the selection. */
1134 this->selected_vehicle = v->index;
1135 this->num_vehicles = UINT8_MAX;
1136 [[fallthrough]];
1137 }
1138
1139 case 2: { // The vehicle selection has changed; rebuild the entire list.
1140 if (!gui_scope) break;
1141 this->BuildRefitList();
1142
1143 /* The vehicle width has changed too. */
1144 this->vehicle_width = GetVehicleWidth(Vehicle::Get(this->window_number), EIT_IN_DETAILS);
1145 uint max_width = 0;
1146
1147 /* Check the width of all cargo information strings. */
1148 for (const auto &list : this->refit_list) {
1149 for (const RefitOption &refit : list.second) {
1150 std::string string = this->GetCapacityString(refit);
1151 if (!string.empty()) {
1152 Dimension dim = GetStringBoundingBox(string);
1153 max_width = std::max(dim.width, max_width);
1154 }
1155 }
1156 }
1157
1158 if (this->information_width < max_width) {
1159 this->information_width = max_width;
1160 this->ReInit();
1161 }
1162 [[fallthrough]];
1163 }
1164
1165 case 1: // A new cargo has been selected.
1166 if (!gui_scope) break;
1167 this->RefreshScrollbar();
1168 break;
1169 }
1170 }
1171
1172 int GetClickPosition(int click_x)
1173 {
1175 if (_current_text_dir == TD_RTL) click_x = matrix_widget->current_x - click_x;
1176 click_x -= this->vehicle_margin;
1177 if (this->hscroll != nullptr) click_x += this->hscroll->GetPosition();
1178
1179 return click_x;
1180 }
1181
1182 void SetSelectedVehicles(int drag_x)
1183 {
1184 drag_x = GetClickPosition(drag_x);
1185
1186 int left_x = std::min(this->click_x, drag_x);
1187 int right_x = std::max(this->click_x, drag_x);
1188 this->num_vehicles = 0;
1189
1191 /* Find the vehicle part that was clicked. */
1192 switch (v->type) {
1193 case VEH_TRAIN: {
1194 /* Don't select anything if we are not clicking in the vehicle. */
1195 if (left_x >= 0) {
1196 const Train *u = Train::From(v);
1197 bool start_counting = false;
1198 for (; u != nullptr; u = u->Next()) {
1199 int current_width = u->GetDisplayImageWidth();
1200 left_x -= current_width;
1201 right_x -= current_width;
1202
1203 if (left_x < 0 && !start_counting) {
1204 this->selected_vehicle = u->index;
1205 start_counting = true;
1206
1207 /* Count the first vehicle, even if articulated part */
1208 this->num_vehicles++;
1209 } else if (start_counting && !u->IsArticulatedPart()) {
1210 /* Do not count articulated parts */
1211 this->num_vehicles++;
1212 }
1213
1214 if (right_x < 0) break;
1215 }
1216 }
1217
1218 /* If the selection is not correct, clear it. */
1219 if (this->num_vehicles != 0) {
1220 if (_ctrl_pressed) this->num_vehicles = UINT8_MAX;
1221 break;
1222 }
1223 [[fallthrough]];
1224 }
1225
1226 default:
1227 /* Clear the selection. */
1228 this->selected_vehicle = v->index;
1229 this->num_vehicles = UINT8_MAX;
1230 break;
1231 }
1232 }
1233
1234 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1235 {
1236 switch (widget) {
1237 case WID_VR_VEHICLE_PANEL_DISPLAY: { // Vehicle image.
1238 if (this->order != INVALID_VEH_ORDER_ID) break;
1240 this->click_x = GetClickPosition(pt.x - nwi->pos_x);
1241 this->SetSelectedVehicles(pt.x - nwi->pos_x);
1243 if (!_ctrl_pressed) {
1245 } else {
1246 /* The vehicle selection has changed. */
1247 this->InvalidateData(2);
1248 }
1249 break;
1250 }
1251
1252 case WID_VR_MATRIX: { // listbox
1253 this->SetSelection(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_VR_MATRIX));
1254 this->SetWidgetDisabledState(WID_VR_REFIT, this->selected_refit == nullptr);
1255 this->InvalidateData(1);
1256
1257 if (click_count == 1) break;
1258 [[fallthrough]];
1259 }
1260
1261 case WID_VR_REFIT: // refit button
1262 if (this->selected_refit != nullptr) {
1263 const Vehicle *v = Vehicle::Get(this->window_number);
1264
1265 if (this->order == INVALID_VEH_ORDER_ID) {
1266 bool delete_window = this->selected_vehicle == v->index && this->num_vehicles == UINT8_MAX;
1267 if (Command<Commands::RefitVehicle>::Post(GetCmdRefitVehMsg(v), v->tile, this->selected_vehicle, this->selected_refit->cargo, this->selected_refit->subtype, false, false, this->num_vehicles) && delete_window) this->Close();
1268 } else {
1269 if (Command<Commands::OrderRefit>::Post(v->tile, v->index, this->order, this->selected_refit->cargo)) this->Close();
1270 }
1271 }
1272 break;
1273 }
1274 }
1275
1276 void OnMouseDrag(Point pt, WidgetID widget) override
1277 {
1278 switch (widget) {
1279 case WID_VR_VEHICLE_PANEL_DISPLAY: { // Vehicle image.
1280 if (this->order != INVALID_VEH_ORDER_ID) break;
1282 this->SetSelectedVehicles(pt.x - nwi->pos_x);
1284 break;
1285 }
1286 }
1287 }
1288
1289 void OnDragDrop(Point pt, WidgetID widget) override
1290 {
1291 switch (widget) {
1292 case WID_VR_VEHICLE_PANEL_DISPLAY: { // Vehicle image.
1293 if (this->order != INVALID_VEH_ORDER_ID) break;
1295 this->SetSelectedVehicles(pt.x - nwi->pos_x);
1296 this->InvalidateData(2);
1297 break;
1298 }
1299 }
1300 }
1301
1302 void OnResize() override
1303 {
1304 this->vehicle_width = GetVehicleWidth(Vehicle::Get(this->window_number), EIT_IN_DETAILS);
1305 this->vscroll->SetCapacityFromWidget(this, WID_VR_MATRIX);
1306 if (this->hscroll != nullptr) this->hscroll->SetCapacityFromWidget(this, WID_VR_VEHICLE_PANEL_DISPLAY);
1307 }
1308};
1309
1310static constexpr std::initializer_list<NWidgetPart> _nested_vehicle_refit_widgets = {
1312 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1313 NWidget(WWT_CAPTION, COLOUR_GREY, WID_VR_CAPTION),
1314 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1315 EndContainer(),
1316 /* Vehicle display + scrollbar. */
1321 EndContainer(),
1322 EndContainer(),
1323 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_VR_SELECT_HEADER), SetStringTip(STR_REFIT_TITLE), SetResize(1, 0),
1324 /* Matrix + scrollbar. */
1328 EndContainer(),
1329 NWidget(WWT_PANEL, COLOUR_GREY, WID_VR_INFO), SetMinimalTextLines(2, WidgetDimensions::unscaled.framerect.Vertical()), SetResize(1, 0), EndContainer(),
1331 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VR_REFIT), SetFill(1, 0), SetResize(1, 0),
1332 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1333 EndContainer(),
1334};
1335
1336static WindowDesc _vehicle_refit_desc(
1337 WDP_AUTO, "view_vehicle_refit", 240, 174,
1340 _nested_vehicle_refit_widgets
1341);
1342
1350void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit)
1351{
1353 RefitWindow *w = new RefitWindow(_vehicle_refit_desc, v, order, auto_refit);
1354 w->parent = parent;
1355}
1356
1358uint ShowRefitOptionsList(int left, int right, int y, EngineID engine)
1359{
1360 /* List of cargo types of this engine */
1361 CargoTypes cmask = GetUnionOfArticulatedRefitMasks(engine, false);
1362 /* List of cargo types available in this climate */
1363 CargoTypes lmask = _cargo_mask;
1364
1365 /* Draw nothing if the engine is not refittable */
1366 if (HasAtMostOneBit(cmask)) return y;
1367
1368 std::string str;
1369 if (cmask == lmask) {
1370 /* Engine can be refitted to all types in this climate */
1371 str = GetString(STR_PURCHASE_INFO_REFITTABLE_TO, STR_PURCHASE_INFO_ALL_TYPES, std::monostate{});
1372 } else {
1373 /* Check if we are able to refit to more cargo types and unable to. If
1374 * so, invert the cargo types to list those that we can't refit to. */
1375 if (CountBits(cmask ^ lmask) < CountBits(cmask) && CountBits(cmask ^ lmask) <= 7) {
1376 cmask ^= lmask;
1377 str = GetString(STR_PURCHASE_INFO_REFITTABLE_TO, STR_PURCHASE_INFO_ALL_BUT, cmask);
1378 } else {
1379 str = GetString(STR_PURCHASE_INFO_REFITTABLE_TO, STR_JUST_CARGO_LIST, cmask);
1380 }
1381 }
1382
1383 return DrawStringMultiLine(left, right, y, INT32_MAX, str);
1384}
1385
1388{
1389 if (!EngInfo(v->engine_type)->callback_mask.Test(VehicleCallbackMask::CargoSuffix)) return STR_EMPTY;
1390 std::array<int32_t, 1> regs100;
1391 uint16_t cb = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v->engine_type, v, regs100);
1392 if (v->GetGRF()->grf_version < 8 && cb == 0xFF) return STR_EMPTY;
1393 if (cb == CALLBACK_FAILED || cb == 0x400) return STR_EMPTY;
1394 if (cb == 0x40F) {
1395 return GetGRFStringID(v->GetGRFID(), static_cast<GRFStringID>(regs100[0]));
1396 }
1397 if (cb > 0x400) {
1399 return STR_EMPTY;
1400 }
1401 return GetGRFStringID(v->GetGRFID(), GRFSTR_MISC_GRF_TEXT + cb);
1402}
1403
1405static bool VehicleGroupLengthSorter(const GUIVehicleGroup &a, const GUIVehicleGroup &b)
1406{
1407 return a.NumVehicles() < b.NumVehicles();
1408}
1409
1411static bool VehicleGroupTotalProfitThisYearSorter(const GUIVehicleGroup &a, const GUIVehicleGroup &b)
1412{
1413 return a.GetDisplayProfitThisYear() < b.GetDisplayProfitThisYear();
1414}
1415
1417static bool VehicleGroupTotalProfitLastYearSorter(const GUIVehicleGroup &a, const GUIVehicleGroup &b)
1418{
1419 return a.GetDisplayProfitLastYear() < b.GetDisplayProfitLastYear();
1420}
1421
1423static bool VehicleGroupAverageProfitThisYearSorter(const GUIVehicleGroup &a, const GUIVehicleGroup &b)
1424{
1425 return a.GetDisplayProfitThisYear() * static_cast<uint>(b.NumVehicles()) < b.GetDisplayProfitThisYear() * static_cast<uint>(a.NumVehicles());
1426}
1427
1429static bool VehicleGroupAverageProfitLastYearSorter(const GUIVehicleGroup &a, const GUIVehicleGroup &b)
1430{
1431 return a.GetDisplayProfitLastYear() * static_cast<uint>(b.NumVehicles()) < b.GetDisplayProfitLastYear() * static_cast<uint>(a.NumVehicles());
1432}
1433
1435static bool VehicleNumberSorter(const Vehicle * const &a, const Vehicle * const &b)
1436{
1437 return a->unitnumber < b->unitnumber;
1438}
1439
1441static bool VehicleNameSorter(const Vehicle * const &a, const Vehicle * const &b)
1442{
1443 static std::string last_name[2] = { {}, {} };
1444
1445 if (a != _last_vehicle[0]) {
1446 _last_vehicle[0] = a;
1447 last_name[0] = GetString(STR_VEHICLE_NAME, a->index);
1448 }
1449
1450 if (b != _last_vehicle[1]) {
1451 _last_vehicle[1] = b;
1452 last_name[1] = GetString(STR_VEHICLE_NAME, b->index);
1453 }
1454
1455 int r = StrNaturalCompare(last_name[0], last_name[1]); // Sort by name (natural sorting).
1456 return (r != 0) ? r < 0: VehicleNumberSorter(a, b);
1457}
1458
1460static bool VehicleAgeSorter(const Vehicle * const &a, const Vehicle * const &b)
1461{
1462 auto r = a->age - b->age;
1463 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1464}
1465
1467static bool VehicleProfitThisYearSorter(const Vehicle * const &a, const Vehicle * const &b)
1468{
1470 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1471}
1472
1474static bool VehicleProfitLastYearSorter(const Vehicle * const &a, const Vehicle * const &b)
1475{
1477 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1478}
1479
1481static bool VehicleCargoSorter(const Vehicle * const &a, const Vehicle * const &b)
1482{
1483 const Vehicle *v;
1484 CargoArray diff{};
1485
1486 /* Append the cargo of the connected waggons */
1487 for (v = a; v != nullptr; v = v->Next()) diff[v->cargo_type] += v->cargo_cap;
1488 for (v = b; v != nullptr; v = v->Next()) diff[v->cargo_type] -= v->cargo_cap;
1489
1490 int r = 0;
1491 for (uint d : diff) {
1492 r = d;
1493 if (r != 0) break;
1494 }
1495
1496 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1497}
1498
1500static bool VehicleReliabilitySorter(const Vehicle * const &a, const Vehicle * const &b)
1501{
1502 int r = a->reliability - b->reliability;
1503 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1504}
1505
1507static bool VehicleMaxSpeedSorter(const Vehicle * const &a, const Vehicle * const &b)
1508{
1510 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1511}
1512
1514static bool VehicleModelSorter(const Vehicle * const &a, const Vehicle * const &b)
1515{
1516 int r = a->engine_type.base() - b->engine_type.base();
1517 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1518}
1519
1521static bool VehicleValueSorter(const Vehicle * const &a, const Vehicle * const &b)
1522{
1523 const Vehicle *u;
1524 Money diff = 0;
1525
1526 for (u = a; u != nullptr; u = u->Next()) diff += u->value;
1527 for (u = b; u != nullptr; u = u->Next()) diff -= u->value;
1528
1529 int r = ClampTo<int32_t>(diff);
1530 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1531}
1532
1534static bool VehicleLengthSorter(const Vehicle * const &a, const Vehicle * const &b)
1535{
1537 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1538}
1539
1541static bool VehicleTimeToLiveSorter(const Vehicle * const &a, const Vehicle * const &b)
1542{
1543 int r = ClampTo<int32_t>((a->max_age - a->age) - (b->max_age - b->age));
1544 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1545}
1546
1548static bool VehicleTimetableDelaySorter(const Vehicle * const &a, const Vehicle * const &b)
1549{
1550 int r = a->lateness_counter - b->lateness_counter;
1551 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1552}
1553
1554void InitializeGUI()
1555{
1556 _grouping = {};
1557 _sorting = {};
1558}
1559
1566static inline void ChangeVehicleWindow(WindowClass window_class, VehicleID from_index, VehicleID to_index)
1567{
1568 Window *w = FindWindowById(window_class, from_index);
1569 if (w != nullptr) {
1570 /* Update window_number */
1571 w->window_number = to_index;
1572 if (w->viewport != nullptr) w->viewport->follow_vehicle = to_index;
1573
1574 /* Update vehicle drag data */
1575 if (_thd.window_class == window_class && _thd.window_number == from_index) {
1576 _thd.window_number = to_index;
1577 }
1578
1579 /* Notify the window. */
1581 }
1582}
1583
1590{
1591 ChangeVehicleWindow(WC_VEHICLE_VIEW, from_index, to_index);
1592 ChangeVehicleWindow(WC_VEHICLE_ORDERS, from_index, to_index);
1593 ChangeVehicleWindow(WC_VEHICLE_REFIT, from_index, to_index);
1594 ChangeVehicleWindow(WC_VEHICLE_DETAILS, from_index, to_index);
1595 ChangeVehicleWindow(WC_VEHICLE_TIMETABLE, from_index, to_index);
1596}
1597
1598static constexpr std::initializer_list<NWidgetPart> _nested_vehicle_list = {
1600 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1602 NWidget(WWT_CAPTION, COLOUR_GREY, WID_VL_CAPTION),
1605 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VL_ORDER_VIEW), SetMinimalSize(61, 14), SetStringTip(STR_GOTO_ORDER_VIEW, STR_GOTO_ORDER_VIEW_TOOLTIP),
1606 EndContainer(),
1607 EndContainer(),
1608 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1609 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1610 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1611 EndContainer(),
1612
1615 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_VL_GROUP_ORDER), SetMinimalSize(0, 12), SetFill(1, 1), SetStringTip(STR_STATION_VIEW_GROUP, STR_TOOLTIP_GROUP_ORDER),
1616 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VL_SORT_ORDER), SetMinimalSize(0, 12), SetFill(1, 1), SetStringTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
1617 EndContainer(),
1619 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VL_GROUP_BY_PULLDOWN), SetMinimalSize(0, 12), SetFill(1, 1), SetToolTip(STR_TOOLTIP_GROUP_ORDER),
1620 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VL_SORT_BY_PULLDOWN), SetMinimalSize(0, 12), SetFill(1, 1), SetToolTip(STR_TOOLTIP_SORT_CRITERIA),
1621 EndContainer(),
1623 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 1), SetResize(1, 0), EndContainer(),
1626 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VL_FILTER_BY_CARGO), SetMinimalSize(0, 12), SetFill(0, 1), SetToolTip(STR_TOOLTIP_FILTER_CRITERIA),
1627 EndContainer(),
1628 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 1), SetResize(1, 0), EndContainer(),
1629 EndContainer(),
1630 EndContainer(),
1631 EndContainer(),
1632
1636 EndContainer(),
1637
1639 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_VL_HIDE_BUTTONS),
1642 SetToolTip(STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
1643 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetResize(1, 0), SetFill(1, 1), EndContainer(),
1645 SetStringTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
1646 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VL_STOP_ALL), SetAspect(WidgetDimensions::ASPECT_VEHICLE_FLAG), SetFill(0, 1),
1647 SetSpriteTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
1648 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VL_START_ALL), SetAspect(WidgetDimensions::ASPECT_VEHICLE_FLAG), SetFill(0, 1),
1649 SetSpriteTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
1650 EndContainer(),
1651 /* Widget to be shown for other companies hiding the previous 5 widgets. */
1652 NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
1653 EndContainer(),
1654 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1655 EndContainer(),
1656};
1657
1658static void DrawSmallOrderList(const Vehicle *v, int left, int right, int y, uint order_arrow_width, VehicleOrderID start)
1659{
1660 auto orders = v->Orders();
1661 if (orders.empty()) return;
1662
1663 bool rtl = _current_text_dir == TD_RTL;
1664 int l_offset = rtl ? 0 : order_arrow_width;
1665 int r_offset = rtl ? order_arrow_width : 0;
1666 int i = 0;
1667 VehicleOrderID oid = start;
1668
1669 do {
1670 if (oid == v->cur_real_order_index) DrawString(left, right, y, rtl ? STR_JUST_LEFT_ARROW : STR_JUST_RIGHT_ARROW, TC_BLACK, SA_LEFT, false, FS_SMALL);
1671
1672 if (orders[oid].IsType(OT_GOTO_STATION)) {
1673 DrawString(left + l_offset, right - r_offset, y, GetString(STR_STATION_NAME, orders[oid].GetDestination()), TC_BLACK, SA_LEFT, false, FS_SMALL);
1674
1676 if (++i == 4) break;
1677 }
1678
1679 oid = v->orders->GetNext(oid);
1680 } while (oid != start);
1681}
1682
1684static void DrawSmallOrderList(const OrderList *orderlist, int left, int right, int y, uint order_arrow_width)
1685{
1686 if (orderlist == nullptr) return;
1687
1688 bool rtl = _current_text_dir == TD_RTL;
1689 int l_offset = rtl ? 0 : order_arrow_width;
1690 int r_offset = rtl ? order_arrow_width : 0;
1691 int i = 0;
1692
1693 for (const Order &order : orderlist->GetOrders()) {
1694 if (order.IsType(OT_GOTO_STATION)) {
1695 DrawString(left + l_offset, right - r_offset, y, GetString(STR_STATION_NAME, order.GetDestination()), TC_BLACK, SA_LEFT, false, FS_SMALL);
1696
1698 if (++i == 4) break;
1699 }
1700 }
1701}
1702
1711void DrawVehicleImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip)
1712{
1713 switch (v->type) {
1714 case VEH_TRAIN: DrawTrainImage(Train::From(v), r, selection, image_type, skip); break;
1715 case VEH_ROAD: DrawRoadVehImage(v, r, selection, image_type, skip); break;
1716 case VEH_SHIP: DrawShipImage(v, r, selection, image_type); break;
1717 case VEH_AIRCRAFT: DrawAircraftImage(v, r, selection, image_type); break;
1718 default: NOT_REACHED();
1719 }
1720}
1721
1728uint GetVehicleListHeight(VehicleType type, uint divisor)
1729{
1730 /* Name + vehicle + profit */
1731 uint base = ScaleGUITrad(GetVehicleHeight(type)) + 2 * GetCharacterHeight(FS_SMALL) + WidgetDimensions::scaled.matrix.Vertical();
1732 /* Drawing of the 4 small orders + profit*/
1733 if (type >= VEH_SHIP) base = std::max(base, 6U * GetCharacterHeight(FS_SMALL) + WidgetDimensions::scaled.matrix.Vertical());
1734
1735 if (divisor == 1) return base;
1736
1737 /* Make sure the height is dividable by divisor */
1738 uint rem = base % divisor;
1739 return base + (rem == 0 ? 0 : divisor - rem);
1740}
1741
1747static int GetUnitNumberWidth(int digits)
1748{
1749 return GetStringBoundingBox(GetString(STR_JUST_COMMA, GetParamMaxDigits(digits))).width;
1750}
1751
1758void BaseVehicleListWindow::DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
1759{
1760 Rect ir = r.WithHeight(line_height).Shrink(WidgetDimensions::scaled.matrix, RectPadding::zero);
1761 bool rtl = _current_text_dir == TD_RTL;
1762
1763 Dimension profit = GetSpriteSize(SPR_PROFIT_LOT);
1764 int text_offset = std::max<int>(profit.width, GetUnitNumberWidth(this->unitnumber_digits)) + WidgetDimensions::scaled.hsep_normal;
1765 Rect tr = ir.Indent(text_offset, rtl);
1766
1767 bool show_orderlist = this->vli.vtype >= VEH_SHIP;
1768 Rect olr = ir.Indent(std::max(ScaleGUITrad(100) + text_offset, ir.Width() / 2), rtl);
1769
1770 int image_left = (rtl && show_orderlist) ? olr.right : tr.left;
1771 int image_right = (!rtl && show_orderlist) ? olr.left : tr.right;
1772
1773 int vehicle_button_x = rtl ? ir.right - profit.width : ir.left;
1774
1775 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->vehgroups);
1776 for (auto it = first; it != last; ++it) {
1777 const GUIVehicleGroup &vehgroup = *it;
1778
1779 DrawString(tr.left, tr.right, ir.bottom - GetCharacterHeight(FS_SMALL) - WidgetDimensions::scaled.framerect.bottom,
1780 GetString(TimerGameEconomy::UsingWallclockUnits() ? STR_VEHICLE_LIST_PROFIT_THIS_PERIOD_LAST_PERIOD : STR_VEHICLE_LIST_PROFIT_THIS_YEAR_LAST_YEAR,
1781 vehgroup.GetDisplayProfitThisYear(),
1782 vehgroup.GetDisplayProfitLastYear()));
1783
1784 DrawVehicleProfitButton(vehgroup.GetOldestVehicleAge(), vehgroup.GetDisplayProfitLastYear(), vehgroup.NumVehicles(), vehicle_button_x, ir.top + GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal);
1785
1786 switch (this->grouping) {
1787 case GB_NONE: {
1788 const Vehicle *v = vehgroup.GetSingleVehicle();
1789
1791 DrawSprite(SPR_WARNING_SIGN, PAL_NONE, vehicle_button_x, ir.top + GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal + profit.height);
1792 }
1793
1794 DrawVehicleImage(v, ir.WithX(image_left, image_right), selected_vehicle, EIT_IN_LIST, 0);
1795
1796 if (_settings_client.gui.show_cargo_in_vehicle_lists) {
1797 /* Get the cargoes the vehicle can carry */
1798 CargoTypes vehicle_cargoes = 0;
1799
1800 for (auto u = v; u != nullptr; u = u->Next()) {
1801 if (u->cargo_cap == 0) continue;
1802
1803 SetBit(vehicle_cargoes, u->cargo_type);
1804 }
1805
1806 if (!v->name.empty()) {
1807 /* The vehicle got a name so we will print it and the cargoes */
1808 DrawString(tr.left, tr.right, ir.top,
1809 GetString(STR_VEHICLE_LIST_NAME_AND_CARGO, STR_VEHICLE_NAME, v->index, STR_VEHICLE_LIST_CARGO, vehicle_cargoes),
1810 TC_BLACK, SA_LEFT, false, FS_SMALL);
1811 } else if (v->group_id != DEFAULT_GROUP) {
1812 /* The vehicle has no name, but is member of a group, so print group name and the cargoes */
1813 DrawString(tr.left, tr.right, ir.top,
1814 GetString(STR_VEHICLE_LIST_NAME_AND_CARGO, STR_GROUP_NAME, v->group_id, STR_VEHICLE_LIST_CARGO, vehicle_cargoes),
1815 TC_BLACK, SA_LEFT, false, FS_SMALL);
1816 } else {
1817 /* The vehicle has no name, and is not a member of a group, so just print the cargoes */
1818 DrawString(tr.left, tr.right, ir.top, GetString(STR_VEHICLE_LIST_CARGO, vehicle_cargoes), TC_BLACK, SA_LEFT, false, FS_SMALL);
1819 }
1820 } else if (!v->name.empty()) {
1821 /* The vehicle got a name so we will print it */
1822 DrawString(tr.left, tr.right, ir.top, GetString(STR_VEHICLE_NAME, v->index), TC_BLACK, SA_LEFT, false, FS_SMALL);
1823 } else if (v->group_id != DEFAULT_GROUP) {
1824 /* The vehicle has no name, but is member of a group, so print group name */
1825 DrawString(tr.left, tr.right, ir.top, GetString(STR_GROUP_NAME, v->group_id), TC_BLACK, SA_LEFT, false, FS_SMALL);
1826 }
1827
1828 if (show_orderlist) DrawSmallOrderList(v, olr.left, olr.right, ir.top + GetCharacterHeight(FS_SMALL), this->order_arrow_width, v->cur_real_order_index);
1829
1830 TextColour tc;
1831 if (v->IsChainInDepot()) {
1832 tc = TC_BLUE;
1833 } else {
1834 tc = (v->age > v->max_age - CalendarTime::DAYS_IN_LEAP_YEAR) ? TC_RED : TC_BLACK;
1835 }
1836
1837 DrawString(ir.left, ir.right, ir.top + WidgetDimensions::scaled.framerect.top, GetString(STR_JUST_COMMA, v->unitnumber), tc);
1838 break;
1839 }
1840
1841 case GB_SHARED_ORDERS:
1842 assert(vehgroup.NumVehicles() > 0);
1843
1844 for (int i = 0; i < static_cast<int>(vehgroup.NumVehicles()); ++i) {
1845 if (image_left + WidgetDimensions::scaled.hsep_wide * i >= image_right) break; // Break if there is no more space to draw any more vehicles anyway.
1846 DrawVehicleImage(vehgroup.vehicles_begin[i], ir.WithX(image_left + WidgetDimensions::scaled.hsep_wide * i, image_right), selected_vehicle, EIT_IN_LIST, 0);
1847 }
1848
1849 if (show_orderlist) DrawSmallOrderList(vehgroup.vehicles_begin[0]->orders, olr.left, olr.right, ir.top + GetCharacterHeight(FS_SMALL), this->order_arrow_width);
1850
1851 DrawString(ir.left, ir.right, ir.top + WidgetDimensions::scaled.framerect.top, GetString(STR_JUST_COMMA, vehgroup.NumVehicles()), TC_BLACK);
1852 break;
1853
1854 default:
1855 NOT_REACHED();
1856 }
1857
1858 ir = ir.Translate(0, line_height);
1859 }
1860}
1861
1862void BaseVehicleListWindow::UpdateSortingFromGrouping()
1863{
1864 /* Set up sorting. Make the window-specific _sorting variable
1865 * point to the correct global _sorting struct so we are freed
1866 * from having conditionals during window operation */
1867 switch (this->vli.vtype) {
1868 case VEH_TRAIN: this->sorting = &_sorting[this->grouping].train; break;
1869 case VEH_ROAD: this->sorting = &_sorting[this->grouping].roadveh; break;
1870 case VEH_SHIP: this->sorting = &_sorting[this->grouping].ship; break;
1871 case VEH_AIRCRAFT: this->sorting = &_sorting[this->grouping].aircraft; break;
1872 default: NOT_REACHED();
1873 }
1874 this->vehgroups.SetSortFuncs(this->GetVehicleSorterFuncs());
1875 this->vehgroups.SetListing(*this->sorting);
1876 this->vehgroups.ForceRebuild();
1877 this->vehgroups.NeedResort();
1878}
1879
1880void BaseVehicleListWindow::UpdateVehicleGroupBy(GroupBy group_by)
1881{
1882 if (this->grouping != group_by) {
1883 /* Save the old sorting option, so that if we change the grouping option back later on,
1884 * UpdateSortingFromGrouping() will automatically restore the saved sorting option. */
1885 *this->sorting = this->vehgroups.GetListing();
1886
1887 this->grouping = group_by;
1888 _grouping[this->vli.type][this->vli.vtype] = group_by;
1889 this->UpdateSortingFromGrouping();
1890 }
1891}
1892
1897struct VehicleListWindow : public BaseVehicleListWindow {
1898private:
1904
1910
1911public:
1913 {
1914 this->CreateNestedTree();
1915
1916 this->GetWidget<NWidgetStacked>(WID_VL_FILTER_BY_CARGO_SEL)->SetDisplayedPlane((this->vli.type == VL_SHARED_ORDERS) ? SZSP_NONE : 0);
1917
1918 this->vscroll = this->GetScrollbar(WID_VL_SCROLLBAR);
1919
1920 /* Set up the window widgets */
1921 this->GetWidget<NWidgetCore>(WID_VL_LIST)->SetToolTip(STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype);
1922
1924 if (this->vli.type == VL_SHARED_ORDERS) {
1925 this->GetWidget<NWidgetCore>(WID_VL_CAPTION_SHARED_ORDERS)->SetString(STR_VEHICLE_LIST_SHARED_ORDERS_LIST_CAPTION);
1926 /* If we are in the shared orders window, then disable the group-by dropdown menu.
1927 * Remove this when the group-by dropdown menu has another option apart from grouping by shared orders. */
1931 } else {
1932 this->GetWidget<NWidgetCore>(WID_VL_CAPTION)->SetString(STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype);
1934 }
1935
1937 if (this->vli.company != OWNER_NONE) this->owner = this->vli.company;
1938
1939 this->BuildVehicleList();
1940 this->SortVehicleList();
1941 }
1942
1943 ~VehicleListWindow() override
1944 {
1945 *this->sorting = this->vehgroups.GetListing();
1946 }
1947
1948 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1949 {
1950 switch (widget) {
1951 case WID_VL_LIST:
1952 fill.height = resize.height = GetVehicleListHeight(this->vli.vtype, 1);
1953
1954 switch (this->vli.vtype) {
1955 case VEH_TRAIN:
1956 case VEH_ROAD:
1957 size.height = 6 * resize.height;
1958 break;
1959 case VEH_SHIP:
1960 case VEH_AIRCRAFT:
1961 size.height = 4 * resize.height;
1962 break;
1963 default: NOT_REACHED();
1964 }
1965 break;
1966
1967 case WID_VL_SORT_ORDER: {
1969 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
1970 d.height += padding.height;
1971 size = maxdim(size, d);
1972 break;
1973 }
1974
1976 size.width = GetStringListWidth(this->vehicle_group_by_names) + padding.width;
1977 break;
1978
1980 size.width = GetStringListWidth(this->vehicle_group_none_sorter_names_calendar);
1981 size.width = std::max(size.width, GetStringListWidth(this->vehicle_group_none_sorter_names_wallclock));
1982 size.width = std::max(size.width, GetStringListWidth(this->vehicle_group_shared_orders_sorter_names_calendar));
1983 size.width = std::max(size.width, GetStringListWidth(this->vehicle_group_shared_orders_sorter_names_wallclock));
1984 size.width += padding.width;
1985 break;
1986
1988 size.width = std::max(size.width, GetDropDownListDimension(this->BuildCargoDropDownList(true)).width + padding.width);
1989 break;
1990
1992 Dimension d = this->GetActionDropdownSize(this->vli.type == VL_STANDARD, false, true);
1993 d.height += padding.height;
1994 d.width += padding.width;
1995 size = maxdim(size, d);
1996 break;
1997 }
1998 }
1999 }
2000
2001 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
2002 {
2003 switch (widget) {
2005 return GetString(STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
2006
2008 return GetString(std::data(this->vehicle_group_by_names)[this->grouping]);
2009
2011 return GetString(this->GetVehicleSorterNames()[this->vehgroups.SortType()]);
2012
2014 return GetString(this->GetCargoFilterLabel(this->cargo_filter_criteria));
2015
2016 case WID_VL_CAPTION:
2018 switch (this->vli.type) {
2019 case VL_SHARED_ORDERS: // Shared Orders
2020 return GetString(stringid, this->vehicles.size());
2021
2022 case VL_STANDARD: // Company Name
2023 return GetString(stringid, STR_COMPANY_NAME, this->vli.ToCompanyID(), std::monostate{}, this->vehicles.size());
2024
2025 case VL_STATION_LIST: // Station/Waypoint Name
2026 return GetString(stringid, Station::IsExpected(BaseStation::Get(this->vli.ToStationID())) ? STR_STATION_NAME : STR_WAYPOINT_NAME, this->vli.ToStationID(), std::monostate{}, this->vehicles.size());
2027
2028 case VL_DEPOT_LIST:
2029 return GetString(stringid, STR_DEPOT_CAPTION, this->vli.vtype, this->vli.ToDestinationID(), this->vehicles.size());
2030
2031 default: NOT_REACHED();
2032 }
2033 }
2034
2035 default:
2036 return this->Window::GetWidgetString(widget, stringid);
2037 }
2038 }
2039
2040 void DrawWidget(const Rect &r, WidgetID widget) const override
2041 {
2042 switch (widget) {
2043 case WID_VL_SORT_ORDER:
2044 /* draw arrow pointing up/down for ascending/descending sorting */
2045 this->DrawSortButtonState(widget, this->vehgroups.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
2046 break;
2047
2048 case WID_VL_LIST:
2049 this->DrawVehicleListItems(VehicleID::Invalid(), this->resize.step_height, r);
2050 break;
2051 }
2052 }
2053
2054 void OnPaint() override
2055 {
2056 this->BuildVehicleList();
2057 this->SortVehicleList();
2058
2059 if (this->vehicles.empty() && this->IsWidgetLowered(WID_VL_MANAGE_VEHICLES_DROPDOWN)) {
2061 }
2062
2063 /* Hide the widgets that we will not use in this window
2064 * Some windows contains actions only fit for the owner */
2065 int plane_to_show = (this->owner == _local_company) ? BP_SHOW_BUTTONS : BP_HIDE_BUTTONS;
2067 if (plane_to_show != nwi->shown_plane) {
2068 nwi->SetDisplayedPlane(plane_to_show);
2069 nwi->SetDirty(this);
2070 }
2071 if (this->owner == _local_company) {
2073 this->SetWidgetsDisabledState(this->vehicles.empty(),
2077 }
2078
2079 this->DrawWidgets();
2080 }
2081
2082 bool last_overlay_state = false;
2083 void OnMouseLoop() override
2084 {
2085 if (last_overlay_state != ShowCargoIconOverlay()) {
2086 last_overlay_state = ShowCargoIconOverlay();
2087 this->SetDirty();
2088 }
2089 }
2090
2091 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2092 {
2093 switch (widget) {
2094 case WID_VL_ORDER_VIEW: // Open the shared orders window
2095 assert(this->vli.type == VL_SHARED_ORDERS);
2096 assert(!this->vehicles.empty());
2097 ShowOrdersWindow(this->vehicles[0]);
2098 break;
2099
2100 case WID_VL_SORT_ORDER: // Flip sorting method ascending/descending
2101 this->vehgroups.ToggleSortOrder();
2102 this->SetDirty();
2103 break;
2104
2105 case WID_VL_GROUP_BY_PULLDOWN: // Select sorting criteria dropdown menu
2106 ShowDropDownMenu(this, this->vehicle_group_by_names, this->grouping, WID_VL_GROUP_BY_PULLDOWN, 0, 0);
2107 return;
2108
2109 case WID_VL_SORT_BY_PULLDOWN: // Select sorting criteria dropdown menu
2110 ShowDropDownMenu(this, this->GetVehicleSorterNames(), this->vehgroups.SortType(), WID_VL_SORT_BY_PULLDOWN, 0,
2111 (this->vli.vtype == VEH_TRAIN || this->vli.vtype == VEH_ROAD) ? 0 : (1 << 10));
2112 return;
2113
2114 case WID_VL_FILTER_BY_CARGO: // Cargo filter dropdown
2115 ShowDropDownList(this, this->BuildCargoDropDownList(false), this->cargo_filter_criteria, widget);
2116 break;
2117
2118 case WID_VL_LIST: { // Matrix to show vehicles
2119 auto it = this->vscroll->GetScrolledItemFromWidget(this->vehgroups, pt.y, this, WID_VL_LIST);
2120 if (it == this->vehgroups.end()) return; // click out of list bound
2121
2122 const GUIVehicleGroup &vehgroup = *it;
2123 switch (this->grouping) {
2124 case GB_NONE: {
2125 const Vehicle *v = vehgroup.GetSingleVehicle();
2126 if (!VehicleClicked(v)) {
2127 if (_ctrl_pressed) {
2129 } else {
2131 }
2132 }
2133 break;
2134 }
2135
2136 case GB_SHARED_ORDERS: {
2137 assert(vehgroup.NumVehicles() > 0);
2138 if (!VehicleClicked(vehgroup)) {
2139 const Vehicle *v = vehgroup.vehicles_begin[0];
2140 if (_ctrl_pressed) {
2141 ShowOrdersWindow(v);
2142 } else {
2143 if (vehgroup.NumVehicles() == 1) {
2145 } else {
2146 ShowVehicleListWindow(v);
2147 }
2148 }
2149 }
2150 break;
2151 }
2152
2153 default: NOT_REACHED();
2154 }
2155
2156 break;
2157 }
2158
2160 ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
2161 break;
2162
2165 break;
2166 }
2167
2168 case WID_VL_STOP_ALL:
2169 case WID_VL_START_ALL:
2170 Command<Commands::MassStartStop>::Post(TileIndex{}, widget == WID_VL_START_ALL, true, this->vli);
2171 break;
2172 }
2173 }
2174
2175 void OnDropdownSelect(WidgetID widget, int index, int) override
2176 {
2177 switch (widget) {
2179 this->UpdateVehicleGroupBy(static_cast<GroupBy>(index));
2180 break;
2181
2183 this->vehgroups.SetSortType(index);
2184 break;
2185
2187 this->SetCargoFilter(index);
2188 break;
2189
2191 assert(!this->vehicles.empty());
2192
2193 switch (index) {
2194 case ADI_REPLACE: // Replace window
2196 break;
2197 case ADI_SERVICE: // Send for servicing
2198 case ADI_DEPOT: // Send to Depots
2199 Command<Commands::SendVehicleToDepot>::Post(GetCmdSendToDepotMsg(this->vli.vtype), VehicleID::Invalid(), (index == ADI_SERVICE ? DepotCommandFlag::Service : DepotCommandFlags{}) | DepotCommandFlag::MassSend, this->vli);
2200 break;
2201
2202 case ADI_CREATE_GROUP: // Create group
2203 Command<Commands::AddVehicleToGroup>::Post(CcAddVehicleNewGroup, NEW_GROUP, VehicleID::Invalid(), false, this->vli);
2204 break;
2205
2206 default: NOT_REACHED();
2207 }
2208 break;
2209
2210 default: NOT_REACHED();
2211 }
2212 this->SetDirty();
2213 }
2214
2215 void OnGameTick() override
2216 {
2217 if (this->vehgroups.NeedResort()) {
2218 StationID station = (this->vli.type == VL_STATION_LIST) ? this->vli.ToStationID() : StationID::Invalid();
2219
2220 Debug(misc, 3, "Periodic resort {} list company {} at station {}", this->vli.vtype, this->owner, station);
2221 this->SetDirty();
2222 }
2223 }
2224
2225 void OnResize() override
2226 {
2227 this->vscroll->SetCapacityFromWidget(this, WID_VL_LIST);
2228 }
2229
2235 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
2236 {
2237 if (!gui_scope && HasBit(data, 31) && this->vli.type == VL_SHARED_ORDERS) {
2238 /* Needs to be done in command-scope, so everything stays valid */
2239 this->vli.SetIndex(GB(data, 0, 20));
2240 this->window_number = this->vli.ToWindowNumber();
2241 this->vehgroups.ForceRebuild();
2242 return;
2243 }
2244
2245 if (data == 0) {
2246 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
2247 this->vehgroups.ForceRebuild();
2248 } else {
2249 this->vehgroups.ForceResort();
2250 }
2251 }
2252};
2253
2254static WindowDesc _vehicle_list_desc[] = {
2255 {
2256 WDP_AUTO, "list_vehicles_train", 325, 246,
2258 {},
2259 _nested_vehicle_list
2260 },
2261 {
2262 WDP_AUTO, "list_vehicles_roadveh", 260, 246,
2264 {},
2265 _nested_vehicle_list
2266 },
2267 {
2268 WDP_AUTO, "list_vehicles_ship", 260, 246,
2270 {},
2271 _nested_vehicle_list
2272 },
2273 {
2274 WDP_AUTO, "list_vehicles_aircraft", 260, 246,
2276 {},
2277 _nested_vehicle_list
2278 }
2279};
2280
2281static void ShowVehicleListWindowLocal(CompanyID company, VehicleListType vlt, VehicleType vehicle_type, uint32_t unique_number)
2282{
2283 if (!Company::IsValidID(company) && company != OWNER_NONE) return;
2284
2285 assert(vehicle_type < std::size(_vehicle_list_desc));
2286 VehicleListIdentifier vli(vlt, vehicle_type, company, unique_number);
2287 AllocateWindowDescFront<VehicleListWindow>(_vehicle_list_desc[vehicle_type], vli.ToWindowNumber(), vli);
2288}
2289
2290void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type)
2291{
2292 /* If _settings_client.gui.advanced_vehicle_list > 1, display the Advanced list
2293 * if _settings_client.gui.advanced_vehicle_list == 1, display Advanced list only for local company
2294 * if _ctrl_pressed, do the opposite action (Advanced list x Normal list)
2295 */
2296
2297 if ((_settings_client.gui.advanced_vehicle_list > (uint)(company != _local_company)) != _ctrl_pressed) {
2298 ShowCompanyGroup(company, vehicle_type);
2299 } else {
2300 ShowVehicleListWindowLocal(company, VL_STANDARD, vehicle_type, company.base());
2301 }
2302}
2303
2304void ShowVehicleListWindow(const Vehicle *v)
2305{
2306 ShowVehicleListWindowLocal(v->owner, VL_SHARED_ORDERS, v->type, v->FirstShared()->index.base());
2307}
2308
2309void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station)
2310{
2311 ShowVehicleListWindowLocal(company, VL_STATION_LIST, vehicle_type, station.base());
2312}
2313
2314void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile)
2315{
2316 ShowVehicleListWindowLocal(company, VL_DEPOT_LIST, vehicle_type, GetDepotDestinationIndex(depot_tile).base());
2317}
2318
2319
2320/* Unified vehicle GUI - Vehicle Details Window */
2321
2326
2328static constexpr std::initializer_list<NWidgetPart> _nested_nontrain_vehicle_details_widgets = {
2330 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2331 NWidget(WWT_CAPTION, COLOUR_GREY, WID_VD_CAPTION),
2332 NWidget(WWT_SHADEBOX, COLOUR_GREY),
2333 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
2334 NWidget(WWT_STICKYBOX, COLOUR_GREY),
2335 EndContainer(),
2336 NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_TOP_DETAILS), SetMinimalSize(405, 42), SetResize(1, 0), EndContainer(),
2344 SetStringTip(STR_EMPTY, STR_SERVICE_INTERVAL_DROPDOWN_TOOLTIP),
2346 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
2347 EndContainer(),
2348};
2349
2351static constexpr std::initializer_list<NWidgetPart> _nested_train_vehicle_details_widgets = {
2353 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2354 NWidget(WWT_CAPTION, COLOUR_GREY, WID_VD_CAPTION), SetStringTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2355 NWidget(WWT_SHADEBOX, COLOUR_GREY),
2356 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
2357 NWidget(WWT_STICKYBOX, COLOUR_GREY),
2358 EndContainer(),
2359 NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_TOP_DETAILS), SetResize(1, 0), SetMinimalSize(405, 42), EndContainer(),
2363 EndContainer(),
2370 SetStringTip(STR_EMPTY, STR_SERVICE_INTERVAL_DROPDOWN_TOOLTIP),
2372 EndContainer(),
2375 SetStringTip(STR_VEHICLE_DETAIL_TAB_CARGO, STR_VEHICLE_DETAILS_TRAIN_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
2377 SetStringTip(STR_VEHICLE_DETAIL_TAB_INFORMATION, STR_VEHICLE_DETAILS_TRAIN_INFORMATION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
2379 SetStringTip(STR_VEHICLE_DETAIL_TAB_CAPACITIES, STR_VEHICLE_DETAILS_TRAIN_CAPACITIES_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
2381 SetStringTip(STR_VEHICLE_DETAIL_TAB_TOTAL_CARGO, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
2382 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
2383 EndContainer(),
2384};
2385
2386
2388extern void DrawTrainDetails(const Train *v, const Rect &r, int vscroll_pos, uint16_t vscroll_cap, TrainDetailsWindowTabs det_tab);
2389extern void DrawRoadVehDetails(const Vehicle *v, const Rect &r);
2390extern void DrawShipDetails(const Vehicle *v, const Rect &r);
2391extern void DrawAircraftDetails(const Aircraft *v, const Rect &r);
2392
2393static const StringID _service_interval_dropdown_calendar[] = {
2394 STR_VEHICLE_DETAILS_DEFAULT,
2395 STR_VEHICLE_DETAILS_DAYS,
2396 STR_VEHICLE_DETAILS_PERCENT,
2397};
2398
2399static const StringID _service_interval_dropdown_wallclock[] = {
2400 STR_VEHICLE_DETAILS_DEFAULT,
2401 STR_VEHICLE_DETAILS_MINUTES,
2402 STR_VEHICLE_DETAILS_PERCENT,
2403};
2404
2408 Scrollbar *vscroll = nullptr;
2409
2412 {
2414
2415 this->CreateNestedTree();
2416 this->vscroll = (v->type == VEH_TRAIN ? this->GetScrollbar(WID_VD_SCROLLBAR) : nullptr);
2417 this->FinishInitNested(window_number);
2418
2419 this->owner = v->owner;
2420 }
2421
2427 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
2428 {
2429 if (data == VIWD_AUTOREPLACE) {
2430 /* Autoreplace replaced the vehicle.
2431 * Nothing to do for this window. */
2432 return;
2433 }
2434 if (!gui_scope) return;
2435 const Vehicle *v = Vehicle::Get(this->window_number);
2436 if (v->type == VEH_ROAD) {
2438 uint aimed_height = this->GetRoadVehDetailsHeight(v);
2439 /* If the number of articulated parts changes, the size of the window must change too. */
2440 if (aimed_height != nwid_info->current_y) {
2441 this->ReInit();
2442 }
2443 }
2444 }
2445
2452 {
2453 uint desired_height;
2454 if (v->HasArticulatedPart()) {
2455 /* An articulated RV has its text drawn under the sprite instead of after it, hence 15 pixels extra. */
2456 desired_height = ScaleGUITrad(15) + 3 * GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal * 2;
2457 /* Add space for the cargo amount for each part. */
2458 for (const Vehicle *u = v; u != nullptr; u = u->Next()) {
2459 if (u->cargo_cap != 0) desired_height += GetCharacterHeight(FS_NORMAL);
2460 }
2461 } else {
2462 desired_height = 4 * GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal * 2;
2463 }
2464 return desired_height;
2465 }
2466
2467 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2468 {
2469 switch (widget) {
2470 case WID_VD_TOP_DETAILS: {
2471 Dimension dim = { 0, 0 };
2472 size.height = 4 * GetCharacterHeight(FS_NORMAL) + padding.height;
2473
2474 uint64_t max_value = GetParamMaxValue(INT16_MAX);
2475 dim = maxdim(dim, GetStringBoundingBox(GetString(STR_VEHICLE_INFO_MAX_SPEED, max_value)));
2476 dim = maxdim(dim, GetStringBoundingBox(GetString(STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED, max_value, max_value, max_value)));
2477 dim = maxdim(dim, GetStringBoundingBox(GetString(STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE, max_value, max_value, max_value, max_value)));
2478 dim = maxdim(dim, GetStringBoundingBox(GetString(STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR_MIN_PERFORMANCE, max_value, max_value, max_value)));
2479 dim = maxdim(dim, GetStringBoundingBox(GetString(STR_VEHICLE_INFO_PROFIT_THIS_PERIOD_LAST_PERIOD_MIN_PERFORMANCE, max_value, max_value, max_value)));
2480 dim = maxdim(dim, GetStringBoundingBox(GetString(STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS, max_value, max_value)));
2481 dim = maxdim(dim, GetStringBoundingBox(GetString(TimerGameEconomy::UsingWallclockUnits() ? STR_VEHICLE_INFO_AGE_RUNNING_COST_PERIOD : STR_VEHICLE_INFO_AGE_RUNNING_COST_YR, STR_VEHICLE_INFO_AGE, max_value, max_value, max_value)));
2482 size.width = dim.width + padding.width;
2483 break;
2484 }
2485
2486 case WID_VD_MIDDLE_DETAILS: {
2487 const Vehicle *v = Vehicle::Get(this->window_number);
2488 switch (v->type) {
2489 case VEH_ROAD:
2490 size.height = this->GetRoadVehDetailsHeight(v) + padding.height;
2491 break;
2492
2493 case VEH_SHIP:
2494 size.height = 4 * GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal * 2 + padding.height;
2495 break;
2496
2497 case VEH_AIRCRAFT:
2498 size.height = 5 * GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal * 2 + padding.height;
2499 break;
2500
2501 default:
2502 NOT_REACHED(); // Train uses WID_VD_MATRIX instead.
2503 }
2504 break;
2505 }
2506
2507 case WID_VD_MATRIX:
2508 fill.height = resize.height = std::max<uint>(ScaleGUITrad(14), GetCharacterHeight(FS_NORMAL) + padding.height);
2509 size.height = 4 * resize.height;
2510 break;
2511
2513 Dimension d = maxdim(GetStringListBoundingBox(_service_interval_dropdown_calendar), GetStringListBoundingBox(_service_interval_dropdown_wallclock));
2514 d.width += padding.width;
2515 d.height += padding.height;
2516 size = maxdim(size, d);
2517 break;
2518 }
2519
2521 /* Do we show the last serviced value as a date or minutes since service? */
2523 ? MakeParameters(GetParamMaxValue(MAX_SERVINT_DAYS), STR_VEHICLE_DETAILS_LAST_SERVICE_MINUTES_AGO, EconomyTime::MAX_DATE)
2524 : MakeParameters(GetParamMaxValue(MAX_SERVINT_DAYS), STR_VEHICLE_DETAILS_LAST_SERVICE_DATE, TimerGameEconomy::DateAtStartOfYear(EconomyTime::MAX_YEAR));
2525
2526 size.width = std::max(size.width, GetStringBoundingBox(GetStringWithArgs(STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT, params)).width);
2527 PrepareArgsForNextRun(params);
2528 size.width = std::max(size.width, GetStringBoundingBox(GetStringWithArgs(STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS, params)).width);
2529
2530 size.width += padding.width;
2531 size.height = GetCharacterHeight(FS_NORMAL) + padding.height;
2532 break;
2533 }
2534 }
2535
2537 static bool IsVehicleServiceIntervalEnabled(const VehicleType vehicle_type, CompanyID company_id)
2538 {
2539 if (_local_company != company_id) return false;
2540
2541 const VehicleDefaultSettings *vds = &Company::Get(company_id)->settings.vehicle;
2542 switch (vehicle_type) {
2543 default: NOT_REACHED();
2544 case VEH_TRAIN: return vds->servint_trains != 0;
2545 case VEH_ROAD: return vds->servint_roadveh != 0;
2546 case VEH_SHIP: return vds->servint_ships != 0;
2547 case VEH_AIRCRAFT: return vds->servint_aircraft != 0;
2548 }
2549 }
2550
2560 static void DrawVehicleDetails(const Vehicle *v, const Rect &r, int vscroll_pos, uint vscroll_cap, TrainDetailsWindowTabs det_tab)
2561 {
2562 switch (v->type) {
2563 case VEH_TRAIN: DrawTrainDetails(Train::From(v), r, vscroll_pos, vscroll_cap, det_tab); break;
2564 case VEH_ROAD: DrawRoadVehDetails(v, r); break;
2565 case VEH_SHIP: DrawShipDetails(v, r); break;
2567 default: NOT_REACHED();
2568 }
2569 }
2570
2571 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
2572 {
2573 if (widget == WID_VD_CAPTION) return GetString(STR_VEHICLE_DETAILS_CAPTION, Vehicle::Get(this->window_number)->index);
2574
2575 return this->Window::GetWidgetString(widget, stringid);
2576 }
2577
2578 void DrawWidget(const Rect &r, WidgetID widget) const override
2579 {
2580 const Vehicle *v = Vehicle::Get(this->window_number);
2581
2582 switch (widget) {
2583 case WID_VD_TOP_DETAILS: {
2584 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
2585
2586 /* Draw running cost */
2587 DrawString(tr,
2588 GetString(TimerGameEconomy::UsingWallclockUnits() ? STR_VEHICLE_INFO_AGE_RUNNING_COST_PERIOD : STR_VEHICLE_INFO_AGE_RUNNING_COST_YR,
2589 (v->age + CalendarTime::DAYS_IN_YEAR < v->max_age) ? STR_VEHICLE_INFO_AGE : STR_VEHICLE_INFO_AGE_RED,
2592 v->GetDisplayRunningCost()));
2593 tr.top += GetCharacterHeight(FS_NORMAL);
2594
2595 /* Draw max speed */
2596 uint64_t max_speed = PackVelocity(v->GetDisplayMaxSpeed(), v->type);
2597 if (v->type == VEH_TRAIN ||
2598 (v->type == VEH_ROAD && _settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL)) {
2599 const GroundVehicleCache *gcache = v->GetGroundVehicleCache();
2600 if (v->type == VEH_TRAIN && (_settings_game.vehicle.train_acceleration_model == AM_ORIGINAL ||
2601 Train::From(v)->GetAccelerationType() == VehicleAccelerationModel::Maglev)) {
2602 DrawString(tr, GetString(STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED, gcache->cached_weight, gcache->cached_power, max_speed));
2603 } else {
2604 DrawString(tr, GetString(STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE, gcache->cached_weight, gcache->cached_power, max_speed, gcache->cached_max_te));
2605 }
2606 } else if (v->type == VEH_AIRCRAFT) {
2607 StringID type = v->GetEngine()->GetAircraftTypeText();
2608 if (Aircraft::From(v)->GetRange() > 0) {
2609 DrawString(tr, GetString(STR_VEHICLE_INFO_MAX_SPEED_TYPE_RANGE, max_speed, type, Aircraft::From(v)->GetRange()));
2610 } else {
2611 DrawString(tr, GetString(STR_VEHICLE_INFO_MAX_SPEED_TYPE, max_speed, type));
2612 }
2613 } else {
2614 DrawString(tr, GetString(STR_VEHICLE_INFO_MAX_SPEED, max_speed));
2615 }
2616 tr.top += GetCharacterHeight(FS_NORMAL);
2617
2618 /* Draw profit */
2619 if (v->IsGroundVehicle()) {
2620 DrawString(tr,
2621 GetString(TimerGameEconomy::UsingWallclockUnits() ? STR_VEHICLE_INFO_PROFIT_THIS_PERIOD_LAST_PERIOD_MIN_PERFORMANCE : STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR_MIN_PERFORMANCE,
2625 } else {
2626 DrawString(tr,
2627 GetString(TimerGameEconomy::UsingWallclockUnits() ? STR_VEHICLE_INFO_PROFIT_THIS_PERIOD_LAST_PERIOD : STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR,
2630 }
2631 tr.top += GetCharacterHeight(FS_NORMAL);
2632
2633 /* Draw breakdown & reliability */
2634 DrawString(tr, GetString(STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS, ToPercent16(v->reliability), v->breakdowns_since_last_service));
2635 break;
2636 }
2637
2638 case WID_VD_MATRIX: {
2639 /* For trains only. */
2640 DrawVehicleDetails(v, r.Shrink(WidgetDimensions::scaled.matrix, RectPadding::zero).WithHeight(this->resize.step_height), this->vscroll->GetPosition(), this->vscroll->GetCapacity(), this->tab);
2641 break;
2642 }
2643
2644 case WID_VD_MIDDLE_DETAILS: {
2645 /* For other vehicles, at the place of the matrix. */
2646 bool rtl = _current_text_dir == TD_RTL;
2647 uint sprite_width = GetSingleVehicleWidth(v, EIT_IN_DETAILS) + WidgetDimensions::scaled.framerect.Horizontal();
2648 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
2649
2650 /* Articulated road vehicles use a complete line. */
2651 if (v->type == VEH_ROAD && v->HasArticulatedPart()) {
2652 DrawVehicleImage(v, tr.WithHeight(ScaleGUITrad(GetVehicleHeight(v->type)), false), VehicleID::Invalid(), EIT_IN_DETAILS, 0);
2653 } else {
2654 Rect sr = tr.WithWidth(sprite_width, rtl);
2655 DrawVehicleImage(v, sr.WithHeight(ScaleGUITrad(GetVehicleHeight(v->type)), false), VehicleID::Invalid(), EIT_IN_DETAILS, 0);
2656 }
2657
2658 DrawVehicleDetails(v, tr.Indent(sprite_width, rtl), 0, 0, this->tab);
2659 break;
2660 }
2661
2663 /* Draw service interval text */
2664 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
2665
2666 /* We're using wallclock units. Show minutes since last serviced. */
2668 int minutes_since_serviced = (TimerGameEconomy::date - v->date_of_last_service).base() / EconomyTime::DAYS_IN_ECONOMY_MONTH;
2669 DrawString(tr.left, tr.right, CentreBounds(r.top, r.bottom, GetCharacterHeight(FS_NORMAL)),
2670 GetString(v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_MINUTES,
2671 v->GetServiceInterval(), STR_VEHICLE_DETAILS_LAST_SERVICE_MINUTES_AGO, minutes_since_serviced));
2672 break;
2673 }
2674
2675 /* We're using calendar dates. Show the date of last service. */
2676 DrawString(tr.left, tr.right, CentreBounds(r.top, r.bottom, GetCharacterHeight(FS_NORMAL)),
2677 GetString(v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS,
2678 v->GetServiceInterval(), STR_VEHICLE_DETAILS_LAST_SERVICE_DATE, v->date_of_last_service));
2679 break;
2680 }
2681 }
2682 }
2683
2685 void OnPaint() override
2686 {
2687 const Vehicle *v = Vehicle::Get(this->window_number);
2688
2689 if (v->type == VEH_TRAIN) {
2690 this->LowerWidget(WID_VD_DETAILS_CARGO_CARRIED + this->tab);
2691 this->vscroll->SetCount(GetTrainDetailsWndVScroll(v->index, this->tab));
2692 }
2693
2694 /* Disable service-scroller when interval is set to disabled */
2698
2699 StringID str =
2700 !v->ServiceIntervalIsCustom() ? STR_VEHICLE_DETAILS_DEFAULT :
2701 v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_PERCENT :
2702 TimerGameEconomy::UsingWallclockUnits() ? STR_VEHICLE_DETAILS_MINUTES : STR_VEHICLE_DETAILS_DAYS;
2705
2706 this->DrawWidgets();
2707 }
2708
2709 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2710 {
2711 switch (widget) {
2712 case WID_VD_INCREASE_SERVICING_INTERVAL: // increase int
2713 case WID_VD_DECREASE_SERVICING_INTERVAL: { // decrease int
2714 const Vehicle *v = Vehicle::Get(this->window_number);
2715 int mod;
2716 if (!v->ServiceIntervalIsPercent() && TimerGameEconomy::UsingWallclockUnits()) {
2717 mod = _ctrl_pressed ? 1 : 5;
2718 } else {
2719 mod = _ctrl_pressed ? 5 : 10;
2720 }
2721
2722 mod = (widget == WID_VD_DECREASE_SERVICING_INTERVAL) ? -mod : mod;
2723 mod = GetServiceIntervalClamped(mod + v->GetServiceInterval(), v->ServiceIntervalIsPercent());
2724 if (mod == v->GetServiceInterval()) return;
2725
2726 Command<Commands::ChangeServiceInterval>::Post(STR_ERROR_CAN_T_CHANGE_SERVICING, v->index, mod, true, v->ServiceIntervalIsPercent());
2727 break;
2728 }
2729
2731 const Vehicle *v = Vehicle::Get(this->window_number);
2732 ShowDropDownMenu(this,
2733 TimerGameEconomy::UsingWallclockUnits() ? _service_interval_dropdown_wallclock : _service_interval_dropdown_calendar,
2734 v->ServiceIntervalIsCustom() ? (v->ServiceIntervalIsPercent() ? 2 : 1) : 0, widget, 0, 0);
2735 break;
2736 }
2737
2742 this->SetWidgetsLoweredState(false,
2747
2749 this->SetDirty();
2750 break;
2751 }
2752 }
2753
2754 bool OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
2755 {
2757 const Vehicle *v = Vehicle::Get(this->window_number);
2758 StringID tool_tip;
2759 if (v->ServiceIntervalIsPercent()) {
2760 tool_tip = widget == WID_VD_INCREASE_SERVICING_INTERVAL ? STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP_PERCENT : STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP_PERCENT;
2762 tool_tip = widget == WID_VD_INCREASE_SERVICING_INTERVAL ? STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP_MINUTES : STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP_MINUTES;
2763 } else {
2764 tool_tip = widget == WID_VD_INCREASE_SERVICING_INTERVAL ? STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP_DAYS : STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP_DAYS;
2765 }
2766 GuiShowTooltips(this, GetEncodedString(tool_tip), close_cond);
2767 return true;
2768 }
2769
2770 return false;
2771 }
2772
2773 void OnDropdownSelect(WidgetID widget, int index, int) override
2774 {
2775 switch (widget) {
2777 const Vehicle *v = Vehicle::Get(this->window_number);
2778 bool iscustom = index != 0;
2779 bool ispercent = iscustom ? (index == 2) : Company::Get(v->owner)->settings.vehicle.servint_ispercent;
2780 uint16_t interval = GetServiceIntervalClamped(v->GetServiceInterval(), ispercent);
2781 Command<Commands::ChangeServiceInterval>::Post(STR_ERROR_CAN_T_CHANGE_SERVICING, v->index, interval, iscustom, ispercent);
2782 break;
2783 }
2784 }
2785 }
2786
2787 void OnResize() override
2788 {
2790 if (nwi != nullptr) {
2791 this->vscroll->SetCapacityFromWidget(this, WID_VD_MATRIX);
2792 }
2793 }
2794};
2795
2798 WDP_AUTO, "view_vehicle_details_train", 405, 178,
2800 {},
2802);
2803
2806 WDP_AUTO, "view_vehicle_details", 405, 113,
2808 {},
2810);
2811
2819
2820
2821/* Unified vehicle GUI - Vehicle View Window */
2822
2824static constexpr std::initializer_list<NWidgetPart> _nested_vehicle_view_widgets = {
2826 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2827 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_RENAME), SetAspect(WidgetDimensions::ASPECT_RENAME), SetSpriteTip(SPR_RENAME),
2828 NWidget(WWT_CAPTION, COLOUR_GREY, WID_VV_CAPTION),
2829 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_LOCATION), SetAspect(WidgetDimensions::ASPECT_LOCATION), SetSpriteTip(SPR_GOTO_LOCATION),
2830 NWidget(WWT_DEBUGBOX, COLOUR_GREY),
2831 NWidget(WWT_SHADEBOX, COLOUR_GREY),
2832 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
2833 NWidget(WWT_STICKYBOX, COLOUR_GREY),
2834 EndContainer(),
2836 NWidget(WWT_PANEL, COLOUR_GREY),
2837 NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
2838 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_VV_VIEWPORT), SetMinimalSize(226, 84), SetResize(1, 1),
2839 EndContainer(),
2840 EndContainer(),
2843 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_GOTO_DEPOT), SetMinimalSize(18, 18), SetSpriteTip(SPR_EMPTY /* filled later */),
2844 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_CLONE), SetMinimalSize(18, 18), SetSpriteTip(SPR_EMPTY /* filled later */),
2845 EndContainer(),
2846 /* For trains only, 'ignore signal' button. */
2848 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_VV_FORCE_PROCEED), SetMinimalSize(18, 18),
2849 SetSpriteTip(SPR_IGNORE_SIGNALS, STR_VEHICLE_VIEW_TRAIN_IGNORE_SIGNAL_TOOLTIP),
2850 EndContainer(),
2852 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_REFIT), SetMinimalSize(18, 18), SetSpriteTip(SPR_REFIT_VEHICLE),
2854 SetSpriteTip(SPR_FORCE_VEHICLE_TURN, STR_VEHICLE_VIEW_ROAD_VEHICLE_REVERSE_TOOLTIP),
2855 EndContainer(),
2856 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_SHOW_ORDERS), SetMinimalSize(18, 18), SetSpriteTip(SPR_SHOW_ORDERS),
2857 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_SHOW_DETAILS), SetMinimalSize(18, 18), SetSpriteTip(SPR_SHOW_VEHICLE_DETAILS),
2858 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(18, 0), SetResize(0, 1), EndContainer(),
2859 EndContainer(),
2860 EndContainer(),
2862 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_VV_START_STOP), SetResize(1, 0), SetFill(1, 0),
2863 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_ORDER_LOCATION), SetAspect(WidgetDimensions::ASPECT_LOCATION), SetSpriteTip(SPR_GOTO_LOCATION, STR_VEHICLE_VIEW_ORDER_LOCATION_TOOLTIP),
2864 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
2865 EndContainer(),
2866};
2867
2868/* Just to make sure, nobody has changed the vehicle type constants, as we are
2869 using them for array indexing in a number of places here. */
2870static_assert(VEH_TRAIN == 0);
2871static_assert(VEH_ROAD == 1);
2872static_assert(VEH_SHIP == 2);
2873static_assert(VEH_AIRCRAFT == 3);
2874
2882
2883/* Constants for geometry of vehicle view viewport */
2884static const int VV_INITIAL_VIEWPORT_WIDTH = 226;
2885static const int VV_INITIAL_VIEWPORT_HEIGHT = 84;
2886static const int VV_INITIAL_VIEWPORT_HEIGHT_TRAIN = 102;
2887
2890 VCT_CMD_START_STOP = 0,
2891 VCT_CMD_CLONE_VEH,
2892 VCT_CMD_TURN_AROUND,
2893};
2894
2897 { // VCT_CMD_START_STOP
2898 STR_ERROR_CAN_T_STOP_START_TRAIN,
2899 STR_ERROR_CAN_T_STOP_START_ROAD_VEHICLE,
2900 STR_ERROR_CAN_T_STOP_START_SHIP,
2901 STR_ERROR_CAN_T_STOP_START_AIRCRAFT
2902 },
2903 { // VCT_CMD_CLONE_VEH
2904 STR_ERROR_CAN_T_BUY_TRAIN,
2905 STR_ERROR_CAN_T_BUY_ROAD_VEHICLE,
2906 STR_ERROR_CAN_T_BUY_SHIP,
2907 STR_ERROR_CAN_T_BUY_AIRCRAFT
2908 },
2909 { // VCT_CMD_TURN_AROUND
2910 STR_ERROR_CAN_T_REVERSE_DIRECTION_TRAIN,
2911 STR_ERROR_CAN_T_MAKE_ROAD_VEHICLE_TURN,
2912 INVALID_STRING_ID, // invalid for ships
2913 INVALID_STRING_ID // invalid for aircraft
2914 },
2915};
2916
2922void CcStartStopVehicle(Commands, const CommandCost &result, VehicleID veh_id, bool)
2923{
2924 if (result.Failed()) return;
2925
2926 const Vehicle *v = Vehicle::GetIfValid(veh_id);
2927 if (v == nullptr || !v->IsPrimaryVehicle() || v->owner != _local_company) return;
2928
2929 StringID msg = v->vehstatus.Test(VehState::Stopped) ? STR_VEHICLE_COMMAND_STOPPED : STR_VEHICLE_COMMAND_STARTED;
2930 Point pt = RemapCoords(v->x_pos, v->y_pos, v->z_pos);
2931 AddTextEffect(GetEncodedString(msg), pt.x, pt.y, Ticks::DAY_TICKS, TE_RISING);
2932}
2933
2939void StartStopVehicle(const Vehicle *v, bool texteffect)
2940{
2941 assert(v->IsPrimaryVehicle());
2942 Command<Commands::StartStopVehicle>::Post(_vehicle_msg_translation_table[VCT_CMD_START_STOP][v->type], texteffect ? CcStartStopVehicle : nullptr, v->tile, v->index, false);
2943}
2944
2946static bool IsVehicleRefittable(const Vehicle *v)
2947{
2948 if (!v->IsStoppedInDepot()) return false;
2949
2950 do {
2951 if (IsEngineRefittable(v->engine_type)) return true;
2952 } while (v->IsGroundVehicle() && (v = v->Next()) != nullptr);
2953
2954 return false;
2955}
2956
2958struct VehicleViewWindow : Window {
2959private:
2971 bool mouse_over_start_stop = false;
2972
2978 {
2979 switch (plane) {
2980 case SEL_DC_GOTO_DEPOT:
2981 case SEL_DC_CLONE:
2982 this->GetWidget<NWidgetStacked>(WID_VV_SELECT_DEPOT_CLONE)->SetDisplayedPlane(plane - SEL_DC_BASEPLANE);
2983 break;
2984
2985 case SEL_RT_REFIT:
2986 case SEL_RT_TURN_AROUND:
2987 this->GetWidget<NWidgetStacked>(WID_VV_SELECT_REFIT_TURN)->SetDisplayedPlane(plane - SEL_RT_BASEPLANE);
2988 break;
2989
2990 default:
2991 NOT_REACHED();
2992 }
2993 }
2994
2995public:
2997 {
2999 this->CreateNestedTree();
3000
3001 /* Sprites for the 'send to depot' button indexed by vehicle type. */
3002 static const SpriteID vehicle_view_goto_depot_sprites[] = {
3003 SPR_SEND_TRAIN_TODEPOT,
3004 SPR_SEND_ROADVEH_TODEPOT,
3005 SPR_SEND_SHIP_TODEPOT,
3006 SPR_SEND_AIRCRAFT_TODEPOT,
3007 };
3009 this->GetWidget<NWidgetCore>(WID_VV_GOTO_DEPOT)->SetSprite(vehicle_view_goto_depot_sprites[v->type]);
3010
3011 /* Sprites for the 'clone vehicle' button indexed by vehicle type. */
3012 static const SpriteID vehicle_view_clone_sprites[] = {
3014 SPR_CLONE_ROADVEH,
3015 SPR_CLONE_SHIP,
3016 SPR_CLONE_AIRCRAFT,
3017 };
3018 this->GetWidget<NWidgetCore>(WID_VV_CLONE)->SetSprite(vehicle_view_clone_sprites[v->type]);
3019
3020 switch (v->type) {
3021 case VEH_TRAIN:
3022 this->GetWidget<NWidgetCore>(WID_VV_TURN_AROUND)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_REVERSE_TOOLTIP);
3023 this->GetWidget<NWidgetStacked>(WID_VV_FORCE_PROCEED_SEL)->SetDisplayedPlane(0);
3024 break;
3025
3026 case VEH_ROAD:
3028 break;
3029
3030 case VEH_SHIP:
3031 case VEH_AIRCRAFT:
3034 break;
3035
3036 default: NOT_REACHED();
3037 }
3039 this->owner = v->owner;
3040 this->GetWidget<NWidgetViewport>(WID_VV_VIEWPORT)->InitializeViewport(this, static_cast<VehicleID>(this->window_number), ScaleZoomGUI(_vehicle_view_zoom_levels[v->type]));
3041
3042 this->GetWidget<NWidgetCore>(WID_VV_START_STOP)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_STATUS_START_STOP_TOOLTIP + v->type);
3043 this->GetWidget<NWidgetCore>(WID_VV_RENAME)->SetToolTip(STR_VEHICLE_DETAILS_TRAIN_RENAME + v->type);
3044 this->GetWidget<NWidgetCore>(WID_VV_LOCATION)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_CENTER_TOOLTIP + v->type);
3045 this->GetWidget<NWidgetCore>(WID_VV_REFIT)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_REFIT_TOOLTIP + v->type);
3046 this->GetWidget<NWidgetCore>(WID_VV_GOTO_DEPOT)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_SEND_TO_DEPOT_TOOLTIP + v->type);
3047 this->GetWidget<NWidgetCore>(WID_VV_SHOW_ORDERS)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_ORDERS_TOOLTIP + v->type);
3048 this->GetWidget<NWidgetCore>(WID_VV_SHOW_DETAILS)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_SHOW_DETAILS_TOOLTIP + v->type);
3049 this->GetWidget<NWidgetCore>(WID_VV_CLONE)->SetToolTip(STR_VEHICLE_VIEW_CLONE_TRAIN_INFO + v->type);
3050
3051 this->UpdatePlanes();
3052 this->UpdateButtons();
3053 }
3054
3055 void Close([[maybe_unused]] int data = 0) override
3056 {
3057 CloseWindowById(WC_VEHICLE_ORDERS, this->window_number, false);
3058 CloseWindowById(WC_VEHICLE_REFIT, this->window_number, false);
3059 CloseWindowById(WC_VEHICLE_DETAILS, this->window_number, false);
3060 CloseWindowById(WC_VEHICLE_TIMETABLE, this->window_number, false);
3061 this->Window::Close();
3062 }
3063
3064 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
3065 {
3066 const Vehicle *v = Vehicle::Get(this->window_number);
3067 switch (widget) {
3068 case WID_VV_START_STOP:
3069 size.height = std::max<uint>({size.height, (uint)GetCharacterHeight(FS_NORMAL), GetScaledSpriteSize(SPR_WARNING_SIGN).height, GetScaledSpriteSize(SPR_FLAG_VEH_STOPPED).height, GetScaledSpriteSize(SPR_FLAG_VEH_RUNNING).height}) + padding.height;
3070 break;
3071
3073 if (v->type != VEH_TRAIN) {
3074 size.height = 0;
3075 size.width = 0;
3076 }
3077 break;
3078
3079 case WID_VV_VIEWPORT:
3080 size.width = VV_INITIAL_VIEWPORT_WIDTH;
3081 size.height = (v->type == VEH_TRAIN) ? VV_INITIAL_VIEWPORT_HEIGHT_TRAIN : VV_INITIAL_VIEWPORT_HEIGHT;
3082 break;
3083 }
3084 }
3085
3088 {
3089 const Vehicle *v = Vehicle::Get(this->window_number);
3090 bool is_localcompany = v->owner == _local_company;
3091 bool refittable_and_stopped_in_depot = IsVehicleRefittable(v);
3092
3093 this->SetWidgetDisabledState(WID_VV_RENAME, !is_localcompany);
3094 this->SetWidgetDisabledState(WID_VV_GOTO_DEPOT, !is_localcompany);
3095 this->SetWidgetDisabledState(WID_VV_REFIT, !refittable_and_stopped_in_depot || !is_localcompany);
3096 this->SetWidgetDisabledState(WID_VV_CLONE, !is_localcompany);
3097
3098 if (v->type == VEH_TRAIN) {
3100 this->SetWidgetDisabledState(WID_VV_FORCE_PROCEED, !is_localcompany);
3101 }
3102
3103 if (v->type == VEH_TRAIN || v->type == VEH_ROAD) {
3104 this->SetWidgetDisabledState(WID_VV_TURN_AROUND, !is_localcompany);
3105 }
3106
3108 }
3109
3110 void OnPaint() override
3111 {
3112 const Vehicle *v = Vehicle::Get(this->window_number);
3113
3114 const Window *mainwindow = GetMainWindow();
3115 if (mainwindow->viewport->follow_vehicle == v->index) {
3117 }
3118
3119 this->DrawWidgets();
3120 }
3121
3122 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
3123 {
3124 if (widget != WID_VV_CAPTION) return this->Window::GetWidgetString(widget, stringid);
3125
3126 const Vehicle *v = Vehicle::Get(this->window_number);
3127 return GetString(STR_VEHICLE_VIEW_CAPTION, v->index);
3128 }
3129
3130 std::string GetVehicleStatusString(const Vehicle *v, TextColour &text_colour) const
3131 {
3132 text_colour = TC_BLACK;
3133
3134 if (v->vehstatus.Test(VehState::Crashed)) return GetString(STR_VEHICLE_STATUS_CRASHED);
3135
3136 if (v->type != VEH_AIRCRAFT && v->breakdown_ctr == 1) return GetString(STR_VEHICLE_STATUS_BROKEN_DOWN);
3137
3138 if (v->vehstatus.Test(VehState::Stopped) && (!mouse_over_start_stop || v->IsStoppedInDepot())) {
3139 if (v->type != VEH_TRAIN) return GetString(STR_VEHICLE_STATUS_STOPPED);
3140 if (v->cur_speed != 0) return GetString(STR_VEHICLE_STATUS_TRAIN_STOPPING_VEL, PackVelocity(v->GetDisplaySpeed(), v->type));
3141 if (Train::From(v)->gcache.cached_power == 0) return GetString(STR_VEHICLE_STATUS_TRAIN_NO_POWER);
3142 return GetString(STR_VEHICLE_STATUS_STOPPED);
3143 }
3144
3145 if (v->IsInDepot() && v->IsWaitingForUnbunching()) return GetString(STR_VEHICLE_STATUS_WAITING_UNBUNCHING);
3146
3147 if (v->type == VEH_TRAIN && Train::From(v)->flags.Test(VehicleRailFlag::Stuck) && !v->current_order.IsType(OT_LOADING)) return GetString(STR_VEHICLE_STATUS_TRAIN_STUCK);
3148
3149 if (v->type == VEH_AIRCRAFT && Aircraft::From(v)->flags.Test(VehicleAirFlag::DestinationTooFar) && !v->current_order.IsType(OT_LOADING)) return GetString(STR_VEHICLE_STATUS_AIRCRAFT_TOO_FAR);
3150
3151 /* Vehicle is in a "normal" state, show current order. */
3152 if (mouse_over_start_stop) {
3154 text_colour = TC_RED | TC_FORCED;
3155 } else if (v->type == VEH_TRAIN && Train::From(v)->flags.Test(VehicleRailFlag::Stuck) && !v->current_order.IsType(OT_LOADING)) {
3156 text_colour = TC_ORANGE | TC_FORCED;
3157 }
3158 }
3159
3160 switch (v->current_order.GetType()) {
3161 case OT_GOTO_STATION:
3162 return GetString(v->vehicle_flags.Test(VehicleFlag::PathfinderLost) ? STR_VEHICLE_STATUS_CANNOT_REACH_STATION_VEL : STR_VEHICLE_STATUS_HEADING_FOR_STATION_VEL,
3164
3165 case OT_GOTO_DEPOT: {
3166 /* This case *only* happens when multiple nearest depot orders
3167 * follow each other (including an order list only one order: a
3168 * nearest depot order) and there are no reachable depots.
3169 * It is primarily to guard for the case that there is no
3170 * depot with index 0, which would be used as fallback for
3171 * evaluating the string in the status bar. */
3172 if (v->current_order.GetDestination() == DepotID::Invalid()) return {};
3173
3176 return GetStringWithArgs(v->vehicle_flags.Test(VehicleFlag::PathfinderLost) ? STR_VEHICLE_STATUS_CANNOT_REACH_DEPOT_VEL : STR_VEHICLE_STATUS_HEADING_FOR_DEPOT_VEL, params);
3177 }
3178
3180 return GetStringWithArgs(v->vehicle_flags.Test(VehicleFlag::PathfinderLost) ? STR_VEHICLE_STATUS_CANNOT_REACH_DEPOT_SERVICE_VEL : STR_VEHICLE_STATUS_HEADING_FOR_DEPOT_UNBUNCH_VEL, params);
3181 }
3182
3183 return GetStringWithArgs(v->vehicle_flags.Test(VehicleFlag::PathfinderLost) ? STR_VEHICLE_STATUS_CANNOT_REACH_DEPOT_SERVICE_VEL : STR_VEHICLE_STATUS_HEADING_FOR_DEPOT_SERVICE_VEL, params);
3184 }
3185
3186 case OT_LOADING:
3187 return GetString(STR_VEHICLE_STATUS_LOADING_UNLOADING);
3188
3189 case OT_GOTO_WAYPOINT:
3190 assert(v->type == VEH_TRAIN || v->type == VEH_ROAD || v->type == VEH_SHIP);
3191 return GetString(v->vehicle_flags.Test(VehicleFlag::PathfinderLost) ? STR_VEHICLE_STATUS_CANNOT_REACH_WAYPOINT_VEL : STR_VEHICLE_STATUS_HEADING_FOR_WAYPOINT_VEL,
3193
3194 case OT_LEAVESTATION:
3195 if (v->type != VEH_AIRCRAFT) {
3196 return GetString(STR_VEHICLE_STATUS_LEAVING);
3197 }
3198 [[fallthrough]];
3199
3200 default:
3201 if (v->GetNumManualOrders() == 0) {
3202 return GetString(STR_VEHICLE_STATUS_NO_ORDERS_VEL, PackVelocity(v->GetDisplaySpeed(), v->type));
3203 }
3204
3205 return {};
3206 }
3207 }
3208
3209 void DrawWidget(const Rect &r, WidgetID widget) const override
3210 {
3211 if (widget != WID_VV_START_STOP) return;
3212
3213 /* Draw the flag plus orders. */
3214 bool rtl = (_current_text_dir == TD_RTL);
3215 uint icon_width = std::max({GetScaledSpriteSize(SPR_WARNING_SIGN).width, GetScaledSpriteSize(SPR_FLAG_VEH_STOPPED).width, GetScaledSpriteSize(SPR_FLAG_VEH_RUNNING).width});
3216 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
3217
3218 const Vehicle *v = Vehicle::Get(this->window_number);
3219 SpriteID image = v->vehstatus.Test(VehState::Stopped) ? SPR_FLAG_VEH_STOPPED : (v->vehicle_flags.Test(VehicleFlag::PathfinderLost)) ? SPR_WARNING_SIGN : SPR_FLAG_VEH_RUNNING;
3220 DrawSpriteIgnorePadding(image, PAL_NONE, tr.WithWidth(icon_width, rtl), SA_CENTER);
3221
3222 tr = tr.Indent(icon_width + WidgetDimensions::scaled.imgbtn.Horizontal(), rtl);
3223
3224 TextColour text_colour = TC_FROMSTRING;
3225 std::string str = GetVehicleStatusString(v, text_colour);
3226 DrawString(tr.left, tr.right, CentreBounds(tr.top, tr.bottom, GetCharacterHeight(FS_NORMAL)), str, text_colour, SA_HOR_CENTER);
3227 }
3228
3229 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
3230 {
3231 const Vehicle *v = Vehicle::Get(this->window_number);
3232
3233 switch (widget) {
3234 case WID_VV_RENAME: { // rename
3235 ShowQueryString(GetString(STR_VEHICLE_NAME, v->index), STR_QUERY_RENAME_TRAIN_CAPTION + v->type,
3236 MAX_LENGTH_VEHICLE_NAME_CHARS, this, CS_ALPHANUMERAL, {QueryStringFlag::EnableDefault, QueryStringFlag::LengthIsInChars});
3237 break;
3238 }
3239
3240 case WID_VV_START_STOP: // start stop
3241 StartStopVehicle(v, false);
3242 break;
3243
3244 case WID_VV_ORDER_LOCATION: {
3245 /* Scroll to current order destination */
3246 TileIndex tile = v->current_order.GetLocation(v);
3247 if (tile == INVALID_TILE) break;
3248
3249 if (_ctrl_pressed) {
3251 } else {
3253 }
3254 break;
3255 }
3256
3257 case WID_VV_LOCATION: // center main view
3258 if (_ctrl_pressed) {
3260 } else {
3261 const Window *mainwindow = GetMainWindow();
3262 if (click_count > 1) {
3263 /* main window 'follows' vehicle */
3264 mainwindow->viewport->follow_vehicle = v->index;
3265 } else {
3266 if (mainwindow->viewport->follow_vehicle == v->index) mainwindow->viewport->follow_vehicle = VehicleID::Invalid();
3267 ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
3268 }
3269 }
3270 break;
3271
3272 case WID_VV_GOTO_DEPOT: // goto hangar
3273 Command<Commands::SendVehicleToDepot>::Post(GetCmdSendToDepotMsg(v), v->index, _ctrl_pressed ? DepotCommandFlag::Service : DepotCommandFlags{}, {});
3274 break;
3275 case WID_VV_REFIT: // refit
3277 break;
3278 case WID_VV_SHOW_ORDERS: // show orders
3279 if (_ctrl_pressed) {
3281 } else {
3282 ShowOrdersWindow(v);
3283 }
3284 break;
3285 case WID_VV_SHOW_DETAILS: // show details
3286 if (_ctrl_pressed) {
3288 } else {
3290 }
3291 break;
3292 case WID_VV_CLONE: // clone vehicle
3293 /* Suppress the vehicle GUI when share-cloning.
3294 * There is no point to it except for starting the vehicle.
3295 * For starting the vehicle the player has to open the depot GUI, which is
3296 * most likely already open, but is also visible in the vehicle viewport. */
3297 Command<Commands::CloneVehicle>::Post(_vehicle_msg_translation_table[VCT_CMD_CLONE_VEH][v->type],
3298 _ctrl_pressed ? nullptr : CcCloneVehicle,
3299 v->tile, v->index, _ctrl_pressed);
3300 break;
3301 case WID_VV_TURN_AROUND: // turn around
3302 assert(v->IsGroundVehicle());
3303 if (v->type == VEH_ROAD) {
3304 Command<Commands::TurnRoadVehicle>::Post(_vehicle_msg_translation_table[VCT_CMD_TURN_AROUND][v->type], v->tile, v->index);
3305 } else {
3306 Command<Commands::ReverseTrainDirection>::Post(_vehicle_msg_translation_table[VCT_CMD_TURN_AROUND][v->type], v->tile, v->index, false);
3307 }
3308 break;
3309 case WID_VV_FORCE_PROCEED: // force proceed
3310 assert(v->type == VEH_TRAIN);
3311 Command<Commands::ForceTrainProceed>::Post(STR_ERROR_CAN_T_MAKE_TRAIN_PASS_SIGNAL, v->tile, v->index);
3312 break;
3313 }
3314 }
3315
3316 EventState OnHotkey(int hotkey) override
3317 {
3318 /* If the hotkey is not for any widget in the UI (i.e. for honking) */
3319 if (hotkey == WID_VV_HONK_HORN) {
3320 const Window *mainwindow = GetMainWindow();
3322 /* Only play the sound if we're following this vehicle */
3323 if (mainwindow->viewport->follow_vehicle == v->index) {
3324 v->PlayLeaveStationSound(true);
3325 }
3326 }
3327 return Window::OnHotkey(hotkey);
3328 }
3329
3330 void OnQueryTextFinished(std::optional<std::string> str) override
3331 {
3332 if (!str.has_value()) return;
3333
3334 Command<Commands::RenameVehicle>::Post(STR_ERROR_CAN_T_RENAME_TRAIN + Vehicle::Get(this->window_number)->type, static_cast<VehicleID>(this->window_number), *str);
3335 }
3336
3337 void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
3338 {
3339 bool start_stop = widget == WID_VV_START_STOP;
3340 if (start_stop != mouse_over_start_stop) {
3341 mouse_over_start_stop = start_stop;
3343 }
3344 }
3345
3346 void OnMouseWheel(int wheel, WidgetID widget) override
3347 {
3348 if (widget != WID_VV_VIEWPORT) return;
3349 if (_settings_client.gui.scrollwheel_scrolling != ScrollWheelScrolling::Off) {
3350 DoZoomInOutWindow(wheel < 0 ? ZOOM_IN : ZOOM_OUT, this);
3351 }
3352 }
3353
3354 void OnResize() override
3355 {
3356 if (this->viewport != nullptr) {
3358 nvp->UpdateViewportCoordinates(this);
3359 }
3360 }
3361
3364 {
3365 const Vehicle *v = Vehicle::Get(this->window_number);
3366 bool veh_stopped = v->IsStoppedInDepot();
3367
3368 /* Widget WID_VV_GOTO_DEPOT must be hidden if the vehicle is already stopped in depot.
3369 * Widget WID_VV_CLONE_VEH should then be shown, since cloning is allowed only while in depot and stopped.
3370 */
3371 PlaneSelections plane = veh_stopped ? SEL_DC_CLONE : SEL_DC_GOTO_DEPOT;
3372 NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(WID_VV_SELECT_DEPOT_CLONE); // Selection widget 'send to depot' / 'clone'.
3373 if (nwi->shown_plane + SEL_DC_BASEPLANE != plane) {
3374 this->SelectPlane(plane);
3375 }
3376 /* The same system applies to widget WID_VV_REFIT_VEH and VVW_WIDGET_TURN_AROUND.*/
3377 if (v->IsGroundVehicle()) {
3378 plane = veh_stopped ? SEL_RT_REFIT : SEL_RT_TURN_AROUND;
3380 if (nwi->shown_plane + SEL_RT_BASEPLANE != plane) {
3381 this->SelectPlane(plane);
3382 }
3383 }
3384 }
3385
3391 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
3392 {
3393 if (data == VIWD_AUTOREPLACE) {
3394 /* Autoreplace replaced the vehicle.
3395 * Nothing to do for this window. */
3396 return;
3397 }
3398
3399 this->UpdatePlanes();
3400 this->UpdateButtons();
3401 this->SetDirty();
3402 }
3403
3404 bool IsNewGRFInspectable() const override
3405 {
3406 return ::IsNewGRFInspectable(GetGrfSpecFeature(Vehicle::Get(this->window_number)->type), this->window_number);
3407 }
3408
3409 void ShowNewGRFInspectWindow() const override
3410 {
3411 ::ShowNewGRFInspectWindow(GetGrfSpecFeature(Vehicle::Get(this->window_number)->type), this->window_number);
3412 }
3413
3414 static inline HotkeyList hotkeys{"vehicleview", {
3415 Hotkey('H', "honk", WID_VV_HONK_HORN),
3416 }};
3417};
3418
3421 WDP_AUTO, "view_vehicle", 250, 116,
3423 {},
3425 &VehicleViewWindow::hotkeys
3426);
3427
3433 WDP_AUTO, "view_vehicle_train", 250, 134,
3435 {},
3437 &VehicleViewWindow::hotkeys
3438);
3439
3445
3452{
3453 assert(v != nullptr);
3454 if (!(_thd.place_mode & HT_VEHICLE)) return false;
3455
3456 v = v->First();
3457 if (!v->IsPrimaryVehicle()) return false;
3458
3459 return _thd.GetCallbackWnd()->OnVehicleSelect(v);
3460}
3461
3468bool VehicleClicked(VehicleList::const_iterator begin, VehicleList::const_iterator end)
3469{
3470 assert(begin != end);
3471 if (!(_thd.place_mode & HT_VEHICLE)) return false;
3472
3473 /* If there is only one vehicle in the group, act as if we clicked a single vehicle */
3474 if (begin + 1 == end) return _thd.GetCallbackWnd()->OnVehicleSelect(*begin);
3475
3476 return _thd.GetCallbackWnd()->OnVehicleSelect(begin, end);
3477}
3478
3484bool VehicleClicked(const GUIVehicleGroup &vehgroup)
3485{
3486 return VehicleClicked(vehgroup.vehicles_begin, vehgroup.vehicles_end);
3487}
3488
3489void StopGlobalFollowVehicle(const Vehicle *v)
3490{
3491 Window *w = GetMainWindow();
3492 if (w->viewport->follow_vehicle == v->index) {
3493 ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos, true); // lock the main view on the vehicle's last position
3494 w->viewport->CancelFollow(*w);
3495 }
3496}
3497
3498
3504void CcBuildPrimaryVehicle(Commands, const CommandCost &result, VehicleID new_veh_id, uint, uint16_t, CargoArray)
3505{
3506 if (result.Failed()) return;
3507
3508 const Vehicle *v = Vehicle::Get(new_veh_id);
3510}
3511
3519{
3520 switch (v->type) {
3521 case VEH_TRAIN:
3522 return Train::From(v)->GetDisplayImageWidth();
3523
3524 case VEH_ROAD:
3526
3527 default:
3528 bool rtl = _current_text_dir == TD_RTL;
3529 VehicleSpriteSeq seq;
3530 v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
3531 Rect rec;
3532 seq.GetBounds(&rec);
3533 return UnScaleGUI(rec.Width());
3534 }
3535}
3536
3543int GetVehicleWidth(const Vehicle *v, EngineImageType image_type)
3544{
3545 if (v->type == VEH_TRAIN || v->type == VEH_ROAD) {
3546 int vehicle_width = 0;
3547 for (const Vehicle *u = v; u != nullptr; u = u->Next()) {
3548 vehicle_width += GetSingleVehicleWidth(u, image_type);
3549 }
3550 return vehicle_width;
3551 } else {
3552 return GetSingleVehicleWidth(v, image_type);
3553 }
3554}
3555
3562{
3563 bool rtl = _current_text_dir == TD_RTL;
3564
3565 _cursor.sprites.clear();
3566 int total_width = 0;
3567 int y_offset = 0;
3568 bool rotor_seq = false; // Whether to draw the rotor of the vehicle in this step.
3569 bool is_ground_vehicle = v->IsGroundVehicle();
3570
3571 while (v != nullptr) {
3572 if (total_width >= ScaleSpriteTrad(2 * (int)VEHICLEINFO_FULL_VEHICLE_WIDTH)) break;
3573
3575 VehicleSpriteSeq seq;
3576
3577 if (rotor_seq) {
3578 GetCustomRotorSprite(Aircraft::From(v), image_type, &seq);
3579 if (!seq.IsValid()) seq.Set(SPR_ROTOR_STOPPED);
3580 y_offset = -ScaleSpriteTrad(5);
3581 } else {
3582 v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
3583 }
3584
3585 int x_offs = 0;
3586 if (v->type == VEH_TRAIN) x_offs = Train::From(v)->GetCursorImageOffset();
3587
3588 for (uint i = 0; i < seq.count; ++i) {
3589 PaletteID pal2 = v->vehstatus.Test(VehState::Crashed) || !seq.seq[i].pal ? pal : seq.seq[i].pal;
3590 _cursor.sprites.emplace_back(seq.seq[i].sprite, pal2, rtl ? (-total_width + x_offs) : (total_width + x_offs), y_offset);
3591 }
3592
3593 if (v->type == VEH_AIRCRAFT && v->subtype == AIR_HELICOPTER && !rotor_seq) {
3594 /* Draw rotor part in the next step. */
3595 rotor_seq = true;
3596 } else {
3597 total_width += GetSingleVehicleWidth(v, image_type);
3598 v = v->HasArticulatedPart() ? v->GetNextArticulatedPart() : nullptr;
3599 }
3600 }
3601
3602 if (is_ground_vehicle) {
3603 /* Center trains and road vehicles on the front vehicle */
3604 int offs = (ScaleSpriteTrad(VEHICLEINFO_FULL_VEHICLE_WIDTH) - total_width) / 2;
3605 if (rtl) offs = -offs;
3606 for (auto &cs : _cursor.sprites) {
3607 cs.pos.x += offs;
3608 }
3609 }
3610
3612}
Base for aircraft.
@ DestinationTooFar
Next destination is too far away.
Definition aircraft.h:37
@ AIR_HELICOPTER
an helicopter
Definition aircraft.h:29
void DrawAircraftImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
Draws an image of an aircraft.
CargoTypes GetUnionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type)
Ors the refit_masks of all articulated parts.
Functions related to articulated vehicles.
void ShowReplaceGroupVehicleWindow(GroupID id_g, VehicleType vehicletype)
Show the autoreplace configuration window for a particular group.
Functions related to the autoreplace GUIs.
@ PathfinderLost
Vehicle's pathfinder is lost.
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr uint CountBits(T value)
Counts the number of set bits in a variable.
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr bool HasAtMostOneBit(T value)
Test whether value has at most 1 bit set.
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:21
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:104
Dimension GetLargestCargoIconSize()
Get dimensions of largest cargo icon.
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition cargotype.cpp:31
@ Passengers
Passengers.
Definition cargotype.h:50
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
Definition cargotype.h:236
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Set()
Set all bits.
Common return value for all commands.
bool Failed() const
Did this command fail?
static constexpr int DAYS_IN_ECONOMY_MONTH
Days in an economy month, when in wallclock timekeeping mode.
StringID GetAircraftTypeText() const
Get the name of the aircraft type for display purposes.
Definition engine.cpp:470
bool CanCarryCargo() const
Determines whether an engine can carry something.
Definition engine.cpp:171
bool(const GUIVehicleGroup *, CargoType) FilterFunction
Baseclass for nested widgets.
virtual void SetDirty(const Window *w) const
Mark the widget as 'dirty' (in need of repaint).
Definition widget.cpp:931
uint current_x
Current horizontal size (after resizing).
int pos_x
Horizontal position of top-left corner of the widget in the window.
uint current_y
Current vertical size (after resizing).
Base class for a 'real' widget.
void SetStringTip(StringID string, StringID tool_tip)
Set string and tool tip of the nested widget.
Definition widget.cpp:1165
Stacked widgets, widgets all occupying the same space in the window.
int shown_plane
Plane being displayed (for NWID_SELECTION only).
bool SetDisplayedPlane(int plane)
Select which plane to show (for NWID_SELECTION only).
Definition widget.cpp:1423
Nested widget to display a viewport in a window.
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition widget.cpp:2403
Scrollbar data structure.
void SetCount(size_t num)
Sets the number of elements in the list.
auto GetScrolledItemFromWidget(Tcontainer &container, int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Return an iterator pointing to the element of a scrolled widget that a user clicked in.
size_type GetScrolledRowFromWidget(int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition widget.cpp:2426
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2500
void ScrollTowards(size_type position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
auto GetVisibleRangeIterators(Tcontainer &container) const
Get a pair of iterators for the range of visible elements in a container.
size_type GetPosition() const
Gets the position of the first visible element in the list.
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
static constexpr TimerGame< struct Economy >::Date MAX_DATE
static constexpr TimerGame< struct Economy >::Year MAX_YEAR
static Date date
Current date in days (day counter).
static bool UsingWallclockUnits(bool newgame=false)
Check if we are using wallclock units.
static constexpr Year DateToYear(Date date)
static constexpr Date DateAtStartOfYear(Year year)
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:93
Functions related to commands.
@ QueryCost
query cost only, don't build.
Commands
List of commands.
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
Some simple functions to help with accessing containers.
bool include(Container &container, typename Container::const_reference &item)
Helper function to append an item to a container if it is not already contained.
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
Command definitions related to depots.
void CcCloneVehicle(Commands, const CommandCost &result, VehicleID veh_id)
This is the Callback method after the cloning attempt of a vehicle.
Map related accessors for depots.
DestinationID GetDepotDestinationIndex(Tile t)
Get the destination index of a 'depot'.
Definition depot_map.h:66
@ DIR_W
West.
@ DIR_E
East.
void ShowDropDownMenu(Window *w, std::span< const StringID > strings, int selected, WidgetID button, uint32_t disabled_mask, uint32_t hidden_mask, uint width)
Show a dropdown menu window near a widget of the parent window.
Definition dropdown.cpp:459
Dimension GetDropDownListDimension(const DropDownList &list)
Determine width and height required to fully display a DropDownList.
Definition dropdown.cpp:381
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options)
Show a drop down list.
Definition dropdown.cpp:419
Functions related to the drop down widget.
Types related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
bool IsEngineRefittable(EngineID engine)
Check if an engine is refittable.
Definition engine.cpp:1292
Functions related to engines.
@ AutoRefit
Automatic refitting is allowed.
PoolID< uint16_t, struct EngineIDTag, 64000, 0xFFFF > EngineID
Unique identification number of an engine.
Definition engine_type.h:26
@ Maglev
Maglev acceleration model.
Definition engine_type.h:50
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:87
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
int CentreBounds(int min, int max, int size)
Determine where to position a centred object.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:972
void UpdateCursorSize()
Update cursor dimension.
Definition gfx.cpp:1623
bool _shift_pressed
Is Shift pressed?
Definition gfx.cpp:40
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:900
Dimension GetStringListBoundingBox(std::span< const StringID > list, FontSize fontsize)
Get maximum dimension of a list of strings.
Definition gfx.cpp:939
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:669
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
uint GetStringListWidth(std::span< const StringID > list, FontSize fontsize)
Get maximum width of a list of strings.
Definition gfx.cpp:924
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition gfx.cpp:1038
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:788
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition widget.cpp:68
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ FS_SMALL
Index of the small font in the font tables.
Definition gfx_type.h:250
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:249
@ SA_LEFT
Left align the text.
Definition gfx_type.h:388
@ SA_HOR_CENTER
Horizontally center the text.
Definition gfx_type.h:389
@ SA_CENTER
Center both horizontally and vertically.
Definition gfx_type.h:398
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:307
@ TC_FORCED
Ignore colour changes from strings.
Definition gfx_type.h:332
constexpr NWidgetPart SetMatrixDataTip(uint32_t cols, uint32_t rows, StringID tip={})
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetAspect(float ratio, AspectFlags flags=AspectFlag::ResizeX)
Widget part function for setting the aspect ratio.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetArrowWidgetTypeTip(ArrowWidgetValues widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Command definitions related to engine groups.
void CcAddVehicleNewGroup(Commands, const CommandCost &result, GroupID new_group, GroupID, VehicleID, bool, const VehicleListIdentifier &)
Open rename window after adding a vehicle to a new group via drag and drop.
void SetDirty() const
Mark entire window as dirty (in need of re-paint).
Definition window.cpp:969
void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type, GroupID group)
Show the group window for the given company and vehicle type.
void ShowCompanyGroupForVehicle(const Vehicle *v)
Show the group window for the given vehicle.
Functions/definitions that have something to do with groups.
static constexpr GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition group_type.h:18
static constexpr GroupID ALL_GROUP
All vehicles are in this group.
Definition group_type.h:17
static constexpr GroupID NEW_GROUP
Sentinel for a to-be-created group.
Definition group_type.h:16
GUI functions that shouldn't be here.
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Hotkey related functions.
static bool CargoFilter(const Industry *const *industry, const std::pair< CargoType, CargoType > &cargoes)
Cargo filter functions.
Point RemapCoords(int x, int y, int z)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Definition landscape.h:81
#define Rect
Macro that prevents name conflicts between included headers.
#define Point
Macro that prevents name conflicts between included headers.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
Definition main_gui.cpp:93
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:406
constexpr uint ToPercent16(uint i)
Converts a "fract" value 0..65535 to "percent" value 0..100.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
constexpr To ClampTo(From value)
Clamp the given value down to lie within the requested type.
void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition misc_gui.cpp:694
void ShowQueryString(std::string_view str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
static constexpr CargoType CF_FREIGHT
Show only vehicles which carry any freight (non-passenger) cargo.
Definition cargo_type.h:96
static constexpr CargoType CF_NONE
Show only items which do not carry cargo (e.g. train engines).
Definition cargo_type.h:94
static constexpr CargoType CF_ANY
Show all items independent of carried cargo (i.e. no filtering).
Definition cargo_type.h:93
@ CargoSuffix
Show suffix after cargo name.
@ CBID_VEHICLE_CARGO_SUFFIX
Determine the cargo "suffixes" for each refit possibility of a cargo.
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Functions/types related to NewGRF debugging.
GrfSpecFeature GetGrfSpecFeature(TileIndex tile)
Get the GrfSpecFeature associated with the tile.
uint16_t GetVehicleCallback(CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v, std::span< int32_t > regs100)
Evaluate a newgrf callback for vehicles.
StringID GetGRFStringID(uint32_t grfid, GRFStringID stringid)
Returns the index for this stringid associated with its grfID.
Header of Action 04 "universal holder" structure and functions.
StrongType::Typedef< uint32_t, struct GRFStringIDTag, StrongType::Compare, StrongType::Integer > GRFStringID
Type for GRF-internal string IDs.
static constexpr GRFStringID GRFSTR_MISC_GRF_TEXT
Miscellaneous GRF text range.
@ Vehicle
Vehicle news item. (new engine available).
Definition news_type.h:81
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
Command definitions related to orders.
uint8_t VehicleOrderID
The index of an order within its current vehicle (not pool related).
Definition order_type.h:18
@ Halt
Service the vehicle and then halt it.
Definition order_type.h:118
@ Unbunch
Service the vehicle and then unbunch it.
Definition order_type.h:120
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel).
Definition order_type.h:39
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:388
Road vehicle states.
Command definitions related to road vehicles.
void DrawRoadVehImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip)
Draws an image of a road vehicle chain.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
@ Off
Scroll wheel has no effect.
void DrawShipImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
Draws an image of a ship.
Definition ship_gui.cpp:30
@ Train
train found in segment
Definition signal.cpp:247
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
static const PaletteID PALETTE_ALL_BLACK
Exchange any colour by black, needed for painting fictive tiles outside map.
Definition sprites.h:1625
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1619
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition sprites.h:1404
static const SpriteID SPR_CLONE_TRAIN
Clone vehicles stuff.
Definition sprites.h:100
Base classes/functions for stations.
Definition of base types and functions in a cross-platform compatible way.
int StrNaturalCompare(std::string_view s1, std::string_view s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition string.cpp:427
Functions related to low-level strings.
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition string_type.h:25
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:236
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index, bool game_script)
Get a parsed string with most special stringcodes replaced by the string parameters.
Definition strings.cpp:336
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
uint64_t GetParamMaxDigits(uint count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:218
Functions related to OTTD's strings.
static void PrepareArgsForNextRun(std::span< StringParameter > args)
Prepare the string parameters for the next formatting run, resetting the type information.
auto MakeParameters(Args &&... args)
Helper to create the StringParameters with its own buffer with the given parameter values.
int64_t PackVelocity(uint speed, VehicleType type)
Pack velocity and vehicle type for use with SCC_VELOCITY string parameter.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames).
@ TD_RTL
Text is written right-to-left by default.
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition aircraft.h:73
VehicleAirFlags flags
Aircraft flags.
Definition aircraft.h:82
std::string name
Name of vehicle.
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
VehicleFlags vehicle_flags
Used for gradual loading and other miscellaneous things (.
TimerGameTick::Ticks lateness_counter
How many ticks late (or early if negative) this vehicle is.
void SetCargoFilter(CargoType cargo_type)
Set cargo filter for the vehicle group list.
VehicleListIdentifier vli
Identifier of the vehicle list we want to currently show.
void DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const
Draw all the vehicle list items.
VehicleID vehicle_sel
Selected vehicle.
Listing * sorting
Pointer to the vehicle type related sorting.
GroupBy grouping
How we want to group the list.
Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group, bool show_create)
Compute the size for the Action dropdown.
uint order_arrow_width
Width of the arrow in the small order list.
uint8_t unitnumber_digits
The number of digits of the highest unit number.
DropDownList BuildActionDropdownList(bool show_autoreplace, bool show_group, bool show_create)
Display the Action dropdown window.
VehicleList vehicles
List of vehicles. This is the buffer for vehgroups to point into; if this is structurally modified,...
GUIVehicleGroupList vehgroups
List of (groups of) vehicles. This stores iterators of vehicles, and should be rebuilt if vehicles is...
void SetCargoFilterArray()
Populate the filter list and set the cargo filter criteria.
DropDownList BuildCargoDropDownList(bool full) const
Build drop down list for cargo filter selection.
void OnInit() override
Notification that the nested widget tree gets initialized.
CargoType cargo_filter_criteria
Selected cargo filter index.
void FilterVehicleList()
Filter the engine list against the currently selected cargo filter.
VehicleType type
Type of vehicle.
Class for storing amounts of cargo.
Definition cargo_type.h:111
Specification of a cargo type.
Definition cargotype.h:74
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:137
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
StringID name
Name of this type of cargo.
Definition cargotype.h:91
Comparator to sort CargoType by according to desired order.
Definition cargotype.h:244
T y
Y coordinate.
T x
X coordinate.
Dimensions (a width and height) of a rectangle in 2D.
EngineMiscFlags misc_flags
Miscellaneous flags.
VehicleCallbackMasks callback_mask
Bitmask of vehicle callbacks that have to be called.
VehicleList::const_iterator vehicles_end
Pointer to past-the-end element of this vehicle group.
VehicleList::const_iterator vehicles_begin
Pointer to beginning element of this vehicle group.
Cached, frequently calculated values.
uint32_t cached_weight
Total weight of the consist (valid only for the first engine).
uint32_t cached_power
Total power of the consist (valid only for the first engine).
uint16_t cached_total_length
Length of the whole vehicle (valid only for the first engine).
uint32_t cached_max_te
Maximum tractive effort of consist (valid only for the first engine).
List of hotkeys for a window.
Definition hotkeys.h:37
All data for a single hotkey.
Definition hotkeys.h:21
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition order_base.h:274
VehicleOrderID GetNext(VehicleOrderID cur) const
Get the order after the given one or the first one, if the given one is the last one.
Definition order_base.h:363
TileIndex GetLocation(const Vehicle *v, bool airport=false) const
Returns a tile somewhat representing the order destination (not suitable for pathfinding).
DestinationID GetDestination() const
Gets the destination of this order.
Definition order_base.h:99
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:66
OrderType GetType() const
Get the type of order of this order.
Definition order_base.h:72
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition order_base.h:152
Colour for pixel/line drawing.
Definition gfx_type.h:405
static Vehicle * Get(auto index)
static Vehicle * GetIfValid(auto index)
Specification of a rectangle with absolute coordinates of all edges.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
int Width() const
Get width of Rect.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Rect WithX(int new_left, int new_right) const
Create a new Rect, replacing the left and right coordiates.
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
Rect Expand(int s) const
Copy and expand Rect by s pixels.
Option to refit a vehicle chain.
StringID string
GRF-local String to display for the cargo.
CargoType cargo
Cargo to refit to.
uint8_t subtype
Subcargo to use.
bool operator==(const RefitOption &other) const
Equality operator for RefitOption.
Refit cargo window.
void OnInit() override
Notification that the nested widget tree gets initialized.
uint information_width
Width required for correctly displaying all cargoes in the information panel.
void SetSelection(uint click_row)
Select a row.
void BuildRefitList()
Collects all (cargo, subcargo) refit options of a vehicle chain.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
int sprite_left
Left position of the vehicle sprite.
void RefreshScrollbar()
Refresh scrollbar after selection changed.
RefitOptions refit_list
List of refit subtypes available for each sorted cargo.
void OnMouseDrag(Point pt, WidgetID widget) override
An 'object' is being dragged at the provided position, highlight the target if possible.
void OnResize() override
Called after the window got resized.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
const RefitOption * selected_refit
Selected refit option.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
uint vehicle_margin
Margin to use while selecting vehicles when the vehicle image is centered.
uint8_t num_vehicles
Number of selected vehicles.
bool auto_refit
Select cargo for auto-refitting.
int sprite_right
Right position of the vehicle sprite.
VehicleOrderID order
If not INVALID_VEH_ORDER_ID, selection is part of a refit order (rather than execute directly).
VehicleID selected_vehicle
First vehicle in the current selection.
void OnPaint() override
The window must be repainted.
void OnDragDrop(Point pt, WidgetID widget) override
A dragged 'object' has been released.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
Scrollbar * hscroll
Only used for long vehicles.
int vehicle_width
Width of the vehicle being drawn.
Scrollbar * vscroll
The main scrollbar.
int click_x
Position of the first click while dragging.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
std::string GetCapacityString(const RefitOption &option) const
Gets the StringID to use for displaying capacity.
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a road vehicle image in the GUI.
static bool IsExpected(const BaseStation *st)
T * Next() const
Get next vehicle in the chain.
static Train * From(Vehicle *v)
'Train' is either a loco or a wagon.
Definition train.h:91
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
uint16_t cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Default settings for vehicles.
uint16_t servint_aircraft
service interval for aircraft
uint16_t servint_roadveh
service interval for road vehicles
uint16_t servint_ships
service interval for ships
uint16_t servint_trains
service interval for trains
bool OnTooltip(Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
Event to display a custom tooltip.
uint GetRoadVehDetailsHeight(const Vehicle *v)
Gets the desired height for the road vehicle details panel.
static void DrawVehicleDetails(const Vehicle *v, const Rect &r, int vscroll_pos, uint vscroll_cap, TrainDetailsWindowTabs det_tab)
Draw the details for the given vehicle at the position of the Details windows.
void OnPaint() override
Repaint vehicle details window.
static bool IsVehicleServiceIntervalEnabled(const VehicleType vehicle_type, CompanyID company_id)
Checks whether service interval is enabled for the vehicle.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnResize() override
Called after the window got resized.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
VehicleDetailsWindow(WindowDesc &desc, WindowNumber window_number)
Initialize a newly created vehicle details window.
TrainDetailsWindowTabs tab
For train vehicles: which tab is displayed.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
The information about a vehicle list.
Definition vehiclelist.h:32
VehicleListType type
The type of vehicle list.
Definition vehiclelist.h:33
WindowNumber ToWindowNumber() const
Pack a VehicleListIdentifier in 32 bits so it can be used as unique WindowNumber.
VehicleType vtype
The vehicle type associated with this list.
Definition vehiclelist.h:34
Window for the (old) vehicle listing.
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
void OnResize() override
Called after the window got resized.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnPaint() override
The window must be repainted.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
CaptionPlanes
Enumeration of planes of the title row at the top.
@ BP_SHARED_ORDERS
Show the normal caption.
@ BP_NORMAL
Show shared orders caption and buttons.
void OnGameTick() override
Called once per (game) tick.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
ButtonPlanes
Enumeration of planes of the button row at the bottom.
@ BP_HIDE_BUTTONS
Show the empty panel.
@ BP_SHOW_BUTTONS
Show the buttons.
Sprite sequence for a vehicle part.
bool IsValid() const
Check whether the sequence contains any sprites.
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition vehicle.cpp:114
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
Window manager class for viewing a vehicle.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
void OnResize() override
Called after the window got resized.
void ShowNewGRFInspectWindow() const override
Show the NewGRF inspection window.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void SelectPlane(PlaneSelections plane)
Display a plane in the window.
PlaneSelections
Display planes available in the vehicle view window.
@ SEL_RT_BASEPLANE
First plane of the WID_VV_SELECT_REFIT_TURN stacked widget.
@ SEL_RT_TURN_AROUND
Display 'turn around' button in WID_VV_SELECT_REFIT_TURN stacked widget.
@ SEL_DC_BASEPLANE
First plane of the WID_VV_SELECT_DEPOT_CLONE stacked widget.
@ SEL_RT_REFIT
Display 'refit' button in WID_VV_SELECT_REFIT_TURN stacked widget.
@ SEL_DC_GOTO_DEPOT
Display 'goto depot' button in WID_VV_SELECT_DEPOT_CLONE stacked widget.
@ SEL_DC_CLONE
Display 'clone vehicle' button in WID_VV_SELECT_DEPOT_CLONE stacked widget.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnMouseOver(Point pt, WidgetID widget) override
The mouse is currently moving over the window or has just moved outside of the window.
void UpdatePlanes()
Selects apropriate plane for current state of the shown vehicle.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
void OnPaint() override
The window must be repainted.
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
void UpdateButtons()
Update buttons state to match shown vehicle.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnMouseWheel(int wheel, WidgetID widget) override
The mouse wheel has been turned.
bool IsNewGRFInspectable() const override
Is the data related to this window NewGRF inspectable?
Vehicle data structure.
Money GetDisplayProfitThisYear() const
Gets the profit vehicle had this year.
EngineID engine_type
The type of engine used for this vehicle.
virtual int GetDisplaySpeed() const
Gets the speed in km-ish/h that can be sent into string parameters for string processing.
int32_t z_pos
z coordinate.
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition vehicle.cpp:719
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
Vehicle * GetNextArticulatedPart() const
Get the next part of an articulated engine.
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
TimerGameEconomy::Date date_of_last_service
Last economy date the vehicle had a service at a depot.
uint16_t cargo_cap
total capacity
Vehicle * GetFirstEnginePart()
Get the first part of an articulated engine.
uint8_t subtype
subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubty...
bool HasArticulatedPart() const
Check if an engine has an articulated part.
uint8_t breakdown_ctr
Counter for managing breakdown events.
GroupID group_id
Index of group Pool array.
virtual int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into string parameters for string processing.
bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
VehStates vehstatus
Status.
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
CargoType cargo_type
type of cargo this vehicle is carrying
VehicleOrderID GetNumManualOrders() const
Get the number of manually added orders this vehicle has.
Vehicle * First() const
Get the first vehicle of this vehicle chain.
Order current_order
The current order (+ status, like: loading).
Vehicle * Next() const
Get the next vehicle of this vehicle.
int32_t y_pos
y coordinate.
int32_t x_pos
x coordinate.
const GRFFile * GetGRF() const
Retrieve the NewGRF the vehicle is tied to.
Definition vehicle.cpp:729
OrderList * orders
Pointer to the order list for this vehicle.
uint32_t GetDisplayMinPowerToWeight() const
Calculates the minimum power-to-weight ratio using the maximum weight of the ground vehicle.
Definition vehicle.cpp:3261
Money value
Value of the vehicle.
void InvalidateNewGRFCache()
Invalidates cached NewGRF variables.
VehicleCache vcache
Cache of often used vehicle values.
uint32_t GetGRFID() const
Retrieve the GRF ID of the NewGRF the vehicle is tied to.
Definition vehicle.cpp:739
GroundVehicleCache * GetGroundVehicleCache()
Access the ground vehicle cache of the vehicle.
Definition vehicle.cpp:3157
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Money GetDisplayProfitLastYear() const
Gets the profit vehicle had last year.
uint16_t cur_speed
current speed
uint8_t cargo_subtype
Used for livery refits (NewGRF variations).
TimerGameCalendar::Date age
Age in calendar days.
bool IsWaitingForUnbunching() const
Check whether a vehicle inside a depot is waiting for unbunching.
Definition vehicle.cpp:2547
Money GetDisplayRunningCost() const
Gets the running cost of a vehicle that can be sent into string parameters for string processing.
uint8_t breakdowns_since_last_service
Counter for the amount of breakdowns.
TimerGameCalendar::Date max_age
Maximum age.
uint16_t reliability
Reliability.
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
Vehicle * Previous() const
Get the previous vehicle of this vehicle.
virtual void PlayLeaveStationSound(bool force=false) const
Play the sound associated with leaving the station.
virtual bool IsInDepot() const
Check whether the vehicle is in the depot.
TileIndex tile
Current tile index.
Owner owner
Which company owns the vehicle?
UnitID unitnumber
unit number, for display purposes only
virtual void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
Gets the sprite to show for the given direction.
High level window description.
Definition window_gui.h:168
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:274
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:981
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1106
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition widget.cpp:815
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1812
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:766
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing).
Definition window.cpp:3250
Window * parent
Parent window.
Definition window_gui.h:329
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:559
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
Definition window_gui.h:319
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:507
void DrawSortButtonState(WidgetID widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition widget.cpp:798
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1078
ResizeInfo resize
Resize information.
Definition window_gui.h:315
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
Definition window_gui.h:516
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1802
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
Definition window_gui.h:527
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition window_gui.h:317
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:442
int left
x position of left edge of the window
Definition window_gui.h:310
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1835
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:986
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:461
WindowFlags flags
Window flags.
Definition window_gui.h:301
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:316
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:573
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:382
int height
Height of the window (number of pixels down in y direction).
Definition window_gui.h:313
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:312
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
Stuff related to the text buffer GUI.
@ TE_RISING
Make the text effect slowly go upwards.
Definition texteff.hpp:22
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
Functions related to tile highlights.
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
@ HT_DRAG
dragging items in the depot windows
@ HT_VEHICLE
vehicle is accepted as target as well (bitmask)
Functions related to time tabling.
void ShowTimetableWindow(const Vehicle *v)
Show the timetable for a given vehicle.
Base for the train class.
@ Stuck
Train can't get a path reservation.
Definition train.h:32
@ TFP_SIGNAL
Ignore next signal, after the signal ignore being stuck.
Definition train.h:41
Command definitions related to trains.
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:99
PaletteID GetVehiclePalette(const Vehicle *v)
Get the colour map for a vehicle.
Definition vehicle.cpp:2146
void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8_t num_vehicles)
Calculates the set of vehicles that will be affected by a given selection.
Definition vehicle.cpp:3220
@ Crashed
Vehicle is crashed.
@ Stopped
Vehicle is stopped by the player.
Command definitions for vehicles.
void CcStartStopVehicle(Commands, const CommandCost &result, VehicleID veh_id, bool)
This is the Callback method after attempting to start/stop a vehicle.
Functions related to vehicles.
static const TimerGameEconomy::Date VEHICLE_PROFIT_MIN_AGE
Only vehicles older than this have a meaningful profit.
static const Money VEHICLE_PROFIT_THRESHOLD
Threshold for a vehicle to be considered making good profit.
void DrawAircraftDetails(const Aircraft *v, const Rect &r)
Draw the details for the given vehicle at the given position.
static bool CargoFilter(const GUIVehicleGroup *vehgroup, const CargoType cargo_type)
Check whether a vehicle can carry a specific cargo.
int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type)
Get the width of a vehicle (part) in pixels.
void DrawShipDetails(const Vehicle *v, const Rect &r)
Draw the details for the given vehicle at the given position.
Definition ship_gui.cpp:63
int GetVehicleWidth(const Vehicle *v, EngineImageType image_type)
Get the width of a vehicle (including all parts of the consist) in pixels.
StringID GetCargoSubtypeText(const Vehicle *v)
Get the cargo subtype text from NewGRF for the vehicle details window.
static WindowDesc _train_view_desc(WDP_AUTO, "view_vehicle_train", 250, 134, WC_VEHICLE_VIEW, WC_NONE, {}, _nested_vehicle_view_widgets, &VehicleViewWindow::hotkeys)
Vehicle view window descriptor for trains.
static void ChangeVehicleWindow(WindowClass window_class, VehicleID from_index, VehicleID to_index)
Assign a vehicle window a new vehicle.
static bool IsVehicleRefittable(const Vehicle *v)
Checks whether the vehicle may be refitted at the moment.
static constexpr std::initializer_list< NWidgetPart > _nested_train_vehicle_details_widgets
Train details widgets.
void CcBuildPrimaryVehicle(Commands, const CommandCost &result, VehicleID new_veh_id, uint, uint16_t, CargoArray)
This is the Callback method after the construction attempt of a primary vehicle.
uint GetUnitNumberDigits(VehicleList &vehicles)
Get the number of digits the biggest unit number of a set of vehicles has.
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
static const StringID _vehicle_msg_translation_table[][4]
Command codes for the shared buttons indexed by VehicleCommandTranslation and vehicle type.
uint CountDigitsForAllocatingSpace(uint number)
Get the number of digits of space required for the given number.
static const uint MAX_REFIT_CYCLE
Maximum number of refit cycles we try, to prevent infinite loops.
VehicleCommandTranslation
Command indices for the _vehicle_command_translation_table.
uint ShowRefitOptionsList(int left, int right, int y, EngineID engine)
Display list of cargo types of the engine, for the purchase information window.
void DrawVehicleImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip)
Draws an image of a vehicle chain.
void DrawTrainDetails(const Train *v, const Rect &r, int vscroll_pos, uint16_t vscroll_cap, TrainDetailsWindowTabs det_tab)
Draw the details for the given vehicle at the given position.
static const ZoomLevel _vehicle_view_zoom_levels[]
Zoom levels for vehicle views indexed by vehicle type.
static WindowDesc _vehicle_view_desc(WDP_AUTO, "view_vehicle", 250, 116, WC_VEHICLE_VIEW, WC_NONE, {}, _nested_vehicle_view_widgets, &VehicleViewWindow::hotkeys)
Vehicle view window descriptor for all vehicles but trains.
static void DrawVehicleProfitButton(TimerGameEconomy::Date age, Money display_profit_last_year, uint num_vehicles, int x, int y)
draw the vehicle profit button in the vehicle list window.
static int GetUnitNumberWidth(int digits)
Get width required for the formatted unit number display.
static constexpr std::initializer_list< NWidgetPart > _nested_vehicle_view_widgets
Vehicle view widgets.
static bool CargoFilterSingle(const Vehicle *v, const CargoType cargo_type)
Check whether a single vehicle should pass the filter.
static WindowDesc _train_vehicle_details_desc(WDP_AUTO, "view_vehicle_details_train", 405, 178, WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW, {}, _nested_train_vehicle_details_widgets)
Vehicle details window descriptor.
uint8_t GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoType dest_cargo_type)
Get the best fitting subtype when 'cloning'/'replacing' v_from with v_for.
void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index)
Report a change in vehicle IDs (due to autoreplace) to affected vehicle windows.
int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab)
Determines the number of lines in the train details window.
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
uint GetVehicleListHeight(VehicleType type, uint divisor)
Get the height of a vehicle in the vehicle list GUIs.
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes Commands::StartStopVehicle for given vehicle.
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
Set the mouse cursor to look like a vehicle.
static WindowDesc _nontrain_vehicle_details_desc(WDP_AUTO, "view_vehicle_details", 405, 113, WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW, {}, _nested_nontrain_vehicle_details_widgets)
Vehicle details window descriptor for other vehicles than a train.
void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit)
Show the refit window for a vehicle.
void DrawCargoIconOverlays(std::span< const CargoIconOverlay > overlays, int y)
Draw a list of cargo icon overlays.
void AddCargoIconOverlay(std::vector< CargoIconOverlay > &overlays, int x, int width, const Vehicle *v)
Add a cargo icon to the list of overlays.
static constexpr std::initializer_list< NWidgetPart > _nested_nontrain_vehicle_details_widgets
Vehicle details widgets (other than train).
static bool VehicleIndividualToGroupSorterWrapper(GUIVehicleGroup const &a, GUIVehicleGroup const &b)
Wrapper to convert a VehicleIndividualSortFunction to a VehicleGroupSortFunction.
void DrawCargoIconOverlay(int x, int y, CargoType cargo_type)
Draw a cargo icon overlaying an existing sprite, with a black contrast outline.
bool ShowCargoIconOverlay()
Test if cargo icon overlays should be drawn.
static void DrawVehicleRefitWindow(const RefitOptions &refits, const RefitOption *sel, uint pos, uint rows, uint delta, const Rect &r)
Draw the list of available refit options for a consist and highlight the selected refit option (if an...
static void ShowVehicleDetailsWindow(const Vehicle *v)
Shows the vehicle details window of the given vehicle.
void DrawRoadVehDetails(const Vehicle *v, const Rect &r)
Draw the details for the given vehicle at the given position.
std::map< CargoType, std::vector< RefitOption >, CargoTypeComparator > RefitOptions
Available refit options (subtype and string) associated with each cargo type.
void CcStartStopVehicle(Commands, const CommandCost &result, VehicleID veh_id, bool)
This is the Callback method after attempting to start/stop a vehicle.
@ VIWD_CONSIST_CHANGED
Vehicle composition was changed.
Definition vehicle_gui.h:37
@ VIWD_AUTOREPLACE
Autoreplace replaced the vehicle.
Definition vehicle_gui.h:38
uint GetVehicleHeight(VehicleType type)
Get the height of a single vehicle in the GUIs.
Definition vehicle_gui.h:74
TrainDetailsWindowTabs
The tabs in the train details window.
Definition vehicle_gui.h:25
@ TDW_TAB_CAPACITY
Tab with cargo capacity of the vehicles.
Definition vehicle_gui.h:28
@ TDW_TAB_TOTALS
Tab with sum of total cargo transported.
Definition vehicle_gui.h:29
@ TDW_TAB_INFO
Tab with name and value of the vehicles.
Definition vehicle_gui.h:27
@ TDW_TAB_CARGO
Tab with cargo carried by the vehicles.
Definition vehicle_gui.h:26
Functions/classes shared between the different vehicle list GUIs.
EngineImageType
Visualisation contexts of vehicles and engines.
@ EIT_IN_DETAILS
Vehicle drawn in vehicle details, refit window, ...
@ EIT_IN_LIST
Vehicle drawn in vehicle list, group list, ...
PoolID< uint32_t, struct VehicleIDTag, 0xFF000, 0xFFFFF > VehicleID
The type all our vehicle IDs have.
VehicleType
Available vehicle types.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
@ MassSend
Tells that it's a mass send to depot command (type in VLW flag).
@ Service
The vehicle will leave the depot right after arrival (service only).
static const uint MAX_LENGTH_VEHICLE_NAME_CHARS
The maximum length of a vehicle name in characters including '\0'.
@ WID_VR_MATRIX
Options to refit to.
@ WID_VR_SCROLLBAR
Scrollbar for the refit options.
@ WID_VR_SHOW_HSCROLLBAR
Selection widget for the horizontal scrollbar.
@ WID_VR_VEHICLE_PANEL_DISPLAY
Display with a representation of the vehicle to refit.
@ WID_VR_HSCROLLBAR
Horizontal scrollbar or the vehicle display.
@ WID_VR_REFIT
Perform the refit.
@ WID_VR_SELECT_HEADER
Header with question about the cargo to carry.
@ WID_VR_INFO
Information about the currently selected refit option.
@ WID_VR_CAPTION
Caption of window.
@ WID_VL_SORT_BY_PULLDOWN
Sort by dropdown list.
@ WID_VL_START_ALL
Start all button.
@ WID_VL_FILTER_BY_CARGO_SEL
Cargo filter dropdown list panel selector.
@ WID_VL_MANAGE_VEHICLES_DROPDOWN
Manage vehicles dropdown list.
@ WID_VL_HIDE_BUTTONS
Selection to hide the buttons.
@ WID_VL_GROUP_BY_PULLDOWN
Group by dropdown list.
@ WID_VL_AVAILABLE_VEHICLES
Available vehicles.
@ WID_VL_STOP_ALL
Stop all button.
@ WID_VL_CAPTION_SELECTION
Selection for caption.
@ WID_VL_FILTER_BY_CARGO
Cargo filter dropdown list.
@ WID_VL_SORT_ORDER
Sort order.
@ WID_VL_GROUP_ORDER
Group order.
@ WID_VL_SCROLLBAR
Scrollbar for the list.
@ WID_VL_CAPTION
Caption of window (for non shared orders windows).
@ WID_VL_LIST
List of the vehicles.
@ WID_VL_CAPTION_SHARED_ORDERS
Caption of window (for shared orders windows).
@ WID_VL_ORDER_VIEW
Button to open order window (for shared orders windows).
@ WID_VV_GOTO_DEPOT
Order this vehicle to go to the depot.
@ WID_VV_LOCATION
Center the main view on this vehicle.
@ WID_VV_TURN_AROUND
Turn this vehicle around.
@ WID_VV_SELECT_DEPOT_CLONE
Selection widget between 'goto depot', and 'clone vehicle' buttons.
@ WID_VV_FORCE_PROCEED
Force this vehicle to pass a signal at danger.
@ WID_VV_RENAME
Rename vehicle.
@ WID_VV_ORDER_LOCATION
Center the main view on the order's target location.
@ WID_VV_SHOW_ORDERS
Show the orders of this vehicle.
@ WID_VV_CLONE
Clone this vehicle.
@ WID_VV_CAPTION
Caption of window.
@ WID_VV_REFIT
Open the refit window.
@ WID_VV_START_STOP
Start or stop this vehicle, and show information about the current state.
@ WID_VV_SELECT_REFIT_TURN
Selection widget between 'refit' and 'turn around' buttons.
@ WID_VV_SHOW_DETAILS
Show details of this vehicle.
@ WID_VV_VIEWPORT
Viewport widget.
@ WID_VV_HONK_HORN
Honk the vehicles horn (not drawn on UI, only used for hotkey).
@ WID_VV_FORCE_PROCEED_SEL
Container for 'force proceed' button, which can be hidden.
@ WID_VD_DECREASE_SERVICING_INTERVAL
Decrease the servicing interval.
@ WID_VD_CAPTION
Caption of window.
@ WID_VD_SERVICE_INTERVAL_DROPDOWN
Dropdown to select default/days/percent service interval.
@ WID_VD_INCREASE_SERVICING_INTERVAL
Increase the servicing interval.
@ WID_VD_MATRIX
List of details for trains.
@ WID_VD_SERVICING_INTERVAL
Information about the servicing interval.
@ WID_VD_DETAILS_TRAIN_VEHICLES
Show all parts of the train with their description.
@ WID_VD_SCROLLBAR
Scrollbar for train details.
@ WID_VD_DETAILS_TOTAL_CARGO
Show the capacity and carried cargo amounts aggregated per cargo of the train.
@ WID_VD_TOP_DETAILS
Panel with generic details.
@ WID_VD_MIDDLE_DETAILS
Details for non-trains.
@ WID_VD_DETAILS_CAPACITY_OF_EACH
Show the capacity of all train parts.
@ WID_VD_DETAILS_CARGO_CARRIED
Show carried cargo per part of the train.
bool GenerateVehicleSortList(VehicleList *list, const VehicleListIdentifier &vli)
Generate a list of vehicles based on window type.
std::vector< const Vehicle * > VehicleList
A list of vehicles.
Definition vehiclelist.h:68
VehicleListType
Vehicle List type flags.
Definition vehiclelist.h:22
@ VL_STANDARD
Index is the company.
Definition vehiclelist.h:23
@ VL_STATION_LIST
Index is the station.
Definition vehiclelist.h:25
@ VL_DEPOT_LIST
Index is the destination (station for hangar of aircraft, depot for others).
Definition vehiclelist.h:26
@ VL_SHARED_ORDERS
Index is the first vehicle of the shared orders.
Definition vehiclelist.h:24
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Functions related to (drawing on) viewports.
@ ZOOM_IN
Zoom in (get more detailed view).
@ ZOOM_OUT
Zoom out (get helicopter view).
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition widget.cpp:289
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition widget_type.h:40
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:41
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:44
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX).
Definition widget_type.h:57
@ WWT_MATRIX
Grid of rows and columns.
Definition widget_type.h:50
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX).
Definition widget_type.h:55
@ WWT_CAPTION
Window caption (window title between closebox and stickybox).
Definition widget_type.h:52
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:76
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window).
Definition widget_type.h:60
@ NWID_HSCROLLBAR
Horizontal scrollbar.
Definition widget_type.h:75
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window).
Definition widget_type.h:59
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX).
Definition widget_type.h:56
@ NWID_VIEWPORT
Nested widget containing a viewport.
Definition widget_type.h:73
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:61
@ WWT_DEBUGBOX
NewGRF debug box (at top-right of a window, between WWT_CAPTION and WWT_SHADEBOX).
Definition widget_type.h:54
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
@ EqualSize
Containers should keep all their (resizing) children equally large.
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:20
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:21
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1198
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1184
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1155
@ Construction
This window is used for construction; close it whenever changing company.
Definition window_gui.h:153
@ BorderOnly
Draw border only, no background.
Definition window_gui.h:26
Twindow * AllocateWindowDescFront(WindowDesc &desc, WindowNumber window_number, Targs... extra_arguments)
Open a new window.
@ DisableVpScroll
Window does not do autoscroll,.
Definition window_gui.h:234
@ SBS_DOWN
Sort ascending.
Definition window_gui.h:219
@ SBS_UP
Sort descending.
Definition window_gui.h:220
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
int WidgetID
Widget ID.
Definition window_type.h:20
EventState
State of handling an event.
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50
@ WC_SHIPS_LIST
Ships list; Window numbers:
@ WC_TRAINS_LIST
Trains list; Window numbers:
@ WC_VEHICLE_REFIT
Vehicle refit; Window numbers:
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Functions related to zooming.
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition zoom_func.h:107
ZoomLevel ScaleZoomGUI(ZoomLevel value)
Scale zoom level relative to GUI zoom.
Definition zoom_func.h:87
int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition zoom_func.h:77
ZoomLevel
All zoom levels we know.
Definition zoom_type.h:20
@ Ship
Default zoom level for the ship view.
Definition zoom_type.h:39
@ RoadVehicle
Default zoom level for the road vehicle view.
Definition zoom_type.h:41
@ Aircraft
Default zoom level for the aircraft view.
Definition zoom_type.h:38
@ Train
Default zoom level for the train view.
Definition zoom_type.h:40