48#include "table/strings.h"
53static std::array<std::array<BaseVehicleListWindow::GroupBy, VEH_COMPANY_END>, VLT_END> _grouping{};
54static std::array<Sorting, BaseVehicleListWindow::GB_END> _sorting{};
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;
76template <BaseVehicleListWindow::VehicleIndiv
idualSortFunction func>
82const std::initializer_list<BaseVehicleListWindow::VehicleGroupSortFunction * const> BaseVehicleListWindow::vehicle_group_none_sorter_funcs = {
83 &VehicleIndividualToGroupSorterWrapper<VehicleNumberSorter>,
84 &VehicleIndividualToGroupSorterWrapper<VehicleNameSorter>,
85 &VehicleIndividualToGroupSorterWrapper<VehicleAgeSorter>,
86 &VehicleIndividualToGroupSorterWrapper<VehicleProfitThisYearSorter>,
87 &VehicleIndividualToGroupSorterWrapper<VehicleProfitLastYearSorter>,
88 &VehicleIndividualToGroupSorterWrapper<VehicleCargoSorter>,
89 &VehicleIndividualToGroupSorterWrapper<VehicleReliabilitySorter>,
90 &VehicleIndividualToGroupSorterWrapper<VehicleMaxSpeedSorter>,
91 &VehicleIndividualToGroupSorterWrapper<VehicleModelSorter>,
92 &VehicleIndividualToGroupSorterWrapper<VehicleValueSorter>,
93 &VehicleIndividualToGroupSorterWrapper<VehicleLengthSorter>,
94 &VehicleIndividualToGroupSorterWrapper<VehicleTimeToLiveSorter>,
95 &VehicleIndividualToGroupSorterWrapper<VehicleTimetableDelaySorter>,
98const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_none_sorter_names_calendar = {
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,
110 STR_SORT_BY_LIFE_TIME,
111 STR_SORT_BY_TIMETABLE_DELAY,
114const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_none_sorter_names_wallclock = {
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,
126 STR_SORT_BY_LIFE_TIME,
127 STR_SORT_BY_TIMETABLE_DELAY,
130const std::initializer_list<BaseVehicleListWindow::VehicleGroupSortFunction * const> BaseVehicleListWindow::vehicle_group_shared_orders_sorter_funcs = {
131 &VehicleGroupLengthSorter,
132 &VehicleGroupTotalProfitThisYearSorter,
133 &VehicleGroupTotalProfitLastYearSorter,
134 &VehicleGroupAverageProfitThisYearSorter,
135 &VehicleGroupAverageProfitLastYearSorter,
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,
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,
154const std::initializer_list<const StringID> BaseVehicleListWindow::vehicle_group_by_names = {
156 STR_GROUP_BY_SHARED_ORDERS,
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
168 this->vehicle_sel = VehicleID::Invalid();
169 this->grouping = _grouping[vli.
type][vli.
vtype];
170 this->UpdateSortingFromGrouping();
173std::span<const StringID> BaseVehicleListWindow::GetVehicleSorterNames()
const
178 case GB_SHARED_ORDERS:
192 if (number >= 10000)
return 5;
193 if (number >= 1000)
return 4;
194 if (number >= 100)
return 3;
212 for (
const Vehicle *v : vehicles) {
213 unitnumber = std::max<uint>(unitnumber, v->unitnumber);
219void BaseVehicleListWindow::BuildVehicleList()
223 Debug(misc, 3,
"Building vehicle list type {} for company {} given index {}", this->
vli.
type, this->vli.company, this->vli.index);
231 for (
const Vehicle *u = v; u !=
nullptr; u = u->
Next()) {
232 if (u->cargo_cap > 0)
SetBit(used, u->cargo_type);
235 this->used_cargoes = used;
238 uint max_unitnumber = 0;
240 this->
vehgroups.emplace_back(it, it + 1);
242 max_unitnumber = std::max<uint>(max_unitnumber, (*it)->unitnumber);
247 std::stable_sort(this->
vehicles.begin(), this->vehicles.end(), [](
const Vehicle *
const &u,
const Vehicle *
const &v) {
248 return u->FirstShared() < v->FirstShared();
251 uint max_num_vehicles = 0;
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;
259 this->
vehgroups.emplace_back(begin, end);
261 max_num_vehicles = std::max<uint>(max_num_vehicles,
static_cast<uint
>(end - begin));
286 for (
const Vehicle *w = v; w !=
nullptr; w = w->
Next()) {
287 if (w->cargo_cap > 0) {
293 bool have_capacity =
false;
294 for (
const Vehicle *w = v; w !=
nullptr; w = w->
Next()) {
295 if (w->cargo_cap > 0) {
299 have_capacity =
true;
303 return have_capacity;
305 for (
const Vehicle *w = v; w !=
nullptr; w = w->
Next()) {
306 if (w->cargo_cap > 0 && w->cargo_type == cargo_type) {
354 overlays.emplace_back(rtl ? x - width : x, rtl ? x : x + width, v->
cargo_type, v->
cargo_cap);
358 overlays.back().left -= width;
360 overlays.back().right += width;
362 overlays.back().cargo_cap += v->
cargo_cap;
380 if (spr == 0)
return;
393 DrawSprite(spr, PAL_NONE, x - d.width, y - d.height);
403 for (
const auto &cio : overlays) {
404 if (cio.cargo_cap == 0)
continue;
470 }
else if (show_create) {
485 switch (cargo_type) {
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())));
531 if (show_autoreplace) {
532 list.push_back(MakeDropDownListStringItem(STR_VEHICLE_LIST_REPLACE_VEHICLES, ADI_REPLACE));
533 list.push_back(MakeDropDownListDividerItem());
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());
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));
554static const Vehicle *_last_vehicle[2] = {
nullptr,
nullptr };
556void BaseVehicleListWindow::SortVehicleList()
561 _last_vehicle[0] = _last_vehicle[1] =
nullptr;
566 if (list->size() < 2)
return;
567 std::sort(list->begin(), list->end(), &VehicleNumberSorter);
578 }
else if (display_profit_last_year < 0) {
579 spr = SPR_PROFIT_NEGATIVE;
581 spr = SPR_PROFIT_SOME;
583 spr = SPR_PROFIT_LOT;
606 static std::vector<StringID> subtypes;
614 uint8_t ret_refit_cyc = 0;
615 bool success =
false;
616 if (!subtypes.empty()) {
619 const Engine *e = v->GetEngine();
621 if (!
HasBit(e->info.refit_mask, dest_cargo_type) && v->cargo_type != dest_cargo_type)
continue;
623 CargoType old_cargo_type = v->cargo_type;
624 uint8_t old_cargo_subtype = v->cargo_subtype;
627 v->cargo_type = dest_cargo_type;
631 v->cargo_subtype = refit_cyc;
634 v->First()->InvalidateNewGRFCache();
635 v->InvalidateNewGRFCache();
638 if (subtype == STR_EMPTY)
break;
640 if (std::ranges::find(subtypes, subtype) == subtypes.end())
continue;
643 ret_refit_cyc = refit_cyc;
649 v->cargo_type = old_cargo_type;
650 v->cargo_subtype = old_cargo_subtype;
653 v->First()->InvalidateNewGRFCache();
654 v->InvalidateNewGRFCache();
660 return ret_refit_cyc;
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;
708 for (
const auto &pair : refits) {
709 bool has_subtypes = pair.second.size() > 1;
711 if (current >= pos + rows)
break;
714 if ((sel ==
nullptr || sel->
cargo != refit.cargo) && refit.subtype != UINT8_MAX)
continue;
723 if (refit.subtype != UINT8_MAX) {
727 GfxDrawLine(iconcenter, ycenter, iconinner, ycenter, linecolour);
734 TextColour colour = (sel !=
nullptr && sel->
cargo == refit.cargo && sel->
subtype == refit.subtype) ? TC_WHITE : TC_BLACK;
767 std::optional<RefitOption> current_refit_option;
768 if (this->selected_refit !=
nullptr) current_refit_option = *(this->
selected_refit);
769 this->selected_refit =
nullptr;
775 VehicleSet vehicles_to_refit;
779 if (v->
type ==
VEH_TRAIN && std::ranges::find(vehicles_to_refit, v->
index) == vehicles_to_refit.end())
continue;
781 CargoTypes cmask = e->info.refit_mask;
793 if (!
HasBit(cmask, cargo_type))
continue;
796 bool first_vehicle = list.empty();
799 list.emplace_back(cargo_type, UINT8_MAX, STR_EMPTY);
825 if (subtype == STR_EMPTY)
break;
827 RefitOption option{cargo_type,
static_cast<uint8_t
>(refit_cyc), subtype};
831 if (subtype == STR_EMPTY) {
834 for (uint i = 1; i < list.size(); i++) {
835 if (list[i].subtype >= refit_cyc) {
836 list.erase(list.begin() + i, list.end());
844 while (pos < list.size() && list[pos].subtype != refit_cyc) pos++;
845 if (pos < list.size() && list[pos].string != subtype) {
847 list.erase(list.begin() + pos);
865 if (current_refit_option.has_value()) {
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;
873 if (this->selected_refit !=
nullptr)
break;
885 size_t scroll_row = 0;
887 CargoType cargo = this->selected_refit ==
nullptr ? INVALID_CARGO : this->selected_refit->
cargo;
890 if (pair.first == cargo) {
892 scroll_row = rows + (this->selected_refit - pair.second.data());
893 rows += pair.second.size();
913 if (row == click_row) {
914 this->selected_refit = &refit;
919 if (this->selected_refit ==
nullptr || this->selected_refit->
cargo != refit.cargo)
break;
924 this->selected_refit =
nullptr;
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);
957 if (this->hscroll !=
nullptr) this->hscroll->
SetCount(this->vehicle_width);
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;
965 this->sprite_right -= sprite_width;
968 this->sprite_left += sprite_width;
980 size.height =
resize.height * 8;
988 size.width = this->information_width + padding.height;
1011 if (cost.Failed())
return {};
1013 Money money = cost.GetCost();
1014 if (mail_capacity > 0) {
1017 return GetString(STR_PURCHASE_INFO_AIRCRAFT_CAPACITY, option.
cargo, refit_capacity, GetCargoTypeByLabel(CT_MAIL), mail_capacity);
1021 return GetString(STR_REFIT_NEW_CAPACITY_INCOME_FROM_AIRCRAFT_REFIT, option.
cargo, refit_capacity, GetCargoTypeByLabel(CT_MAIL), mail_capacity, -money);
1024 return GetString(STR_REFIT_NEW_CAPACITY_COST_OF_AIRCRAFT_REFIT, option.
cargo, refit_capacity, GetCargoTypeByLabel(CT_MAIL), mail_capacity, money);
1029 return GetString(STR_PURCHASE_INFO_CAPACITY, option.
cargo, refit_capacity, STR_EMPTY);
1033 return GetString(STR_REFIT_NEW_CAPACITY_INCOME_FROM_REFIT, option.
cargo, refit_capacity, -money);
1036 return GetString(STR_REFIT_NEW_CAPACITY_COST_OF_REFIT, option.
cargo, refit_capacity, money);
1045 VehicleID::Invalid(),
EIT_IN_DETAILS, this->hscroll !=
nullptr ? this->hscroll->GetPosition() : 0);
1052 VehicleSet vehicles_to_refit;
1055 int left = INT32_MIN;
1061 const int highlight_bottom = highlight_top +
height - 1;
1065 const bool contained = std::ranges::find(vehicles_to_refit, u->index) != vehicles_to_refit.end();
1066 if (contained &&
left == INT32_MIN) {
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;
1087 if (
left != right) {
1088 Rect hr = {
left, highlight_top, right, highlight_bottom};
1095 int current_width = u->GetDisplayImageWidth();
1096 width += current_width;
1112 if (this->selected_refit !=
nullptr) {
1114 if (!
string.empty()) {
1127 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
1135 this->num_vehicles = UINT8_MAX;
1140 if (!gui_scope)
break;
1151 if (!
string.empty()) {
1153 max_width = std::max(dim.width, max_width);
1158 if (this->information_width < max_width) {
1159 this->information_width = max_width;
1166 if (!gui_scope)
break;
1172 int GetClickPosition(
int click_x)
1182 void SetSelectedVehicles(
int drag_x)
1184 drag_x = GetClickPosition(drag_x);
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;
1197 bool start_counting =
false;
1198 for (; u !=
nullptr; u = u->
Next()) {
1200 left_x -= current_width;
1201 right_x -= current_width;
1203 if (left_x < 0 && !start_counting) {
1205 start_counting =
true;
1208 this->num_vehicles++;
1211 this->num_vehicles++;
1214 if (right_x < 0)
break;
1219 if (this->num_vehicles != 0) {
1229 this->num_vehicles = UINT8_MAX;
1240 this->click_x = GetClickPosition(pt.x - nwi->
pos_x);
1241 this->SetSelectedVehicles(pt.x - nwi->
pos_x);
1257 if (click_count == 1)
break;
1262 if (this->selected_refit !=
nullptr) {
1267 if (
Command<CMD_REFIT_VEHICLE>::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();
1282 this->SetSelectedVehicles(pt.
x - nwi->
pos_x);
1295 this->SetSelectedVehicles(pt.
x - nwi->
pos_x);
1310static constexpr NWidgetPart _nested_vehicle_refit_widgets[] = {
1326 NWidget(
WWT_MATRIX, COLOUR_GREY,
WID_VR_MATRIX),
SetMinimalSize(228, 112),
SetResize(1, 14),
SetFill(1, 1),
SetMatrixDataTip(1, 0),
SetScrollbar(
WID_VR_SCROLLBAR),
1337 WDP_AUTO,
"view_vehicle_refit", 240, 174,
1340 _nested_vehicle_refit_widgets
1369 if (cmask == lmask) {
1371 str =
GetString(STR_PURCHASE_INFO_REFITTABLE_TO, STR_PURCHASE_INFO_ALL_TYPES, std::monostate{});
1377 str =
GetString(STR_PURCHASE_INFO_REFITTABLE_TO, STR_PURCHASE_INFO_ALL_BUT, cmask);
1379 str =
GetString(STR_PURCHASE_INFO_REFITTABLE_TO, STR_JUST_CARGO_LIST, cmask);
1390 std::array<int32_t, 1> regs100;
1392 if (v->
GetGRF()->grf_version < 8 && cb == 0xFF)
return STR_EMPTY;
1407 return a.NumVehicles() < b.NumVehicles();
1413 return a.GetDisplayProfitThisYear() < b.GetDisplayProfitThisYear();
1419 return a.GetDisplayProfitLastYear() < b.GetDisplayProfitLastYear();
1425 return a.GetDisplayProfitThisYear() *
static_cast<uint
>(b.NumVehicles()) < b.GetDisplayProfitThisYear() *
static_cast<uint
>(a.NumVehicles());
1431 return a.GetDisplayProfitLastYear() *
static_cast<uint
>(b.NumVehicles()) < b.GetDisplayProfitLastYear() *
static_cast<uint
>(a.NumVehicles());
1443 static std::string last_name[2] = { {}, {} };
1445 if (a != _last_vehicle[0]) {
1446 _last_vehicle[0] = a;
1450 if (b != _last_vehicle[1]) {
1451 _last_vehicle[1] = b;
1456 return (r != 0) ? r < 0: VehicleNumberSorter(a, b);
1462 auto r = a->
age - b->
age;
1463 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1467static bool VehicleProfitThisYearSorter(
const Vehicle *
const &a,
const Vehicle *
const &b)
1470 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1474static bool VehicleProfitLastYearSorter(
const Vehicle *
const &a,
const Vehicle *
const &b)
1477 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1491 for (uint d : diff) {
1496 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1500static bool VehicleReliabilitySorter(
const Vehicle *
const &a,
const Vehicle *
const &b)
1503 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1510 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1517 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1526 for (u = a; u !=
nullptr; u = u->
Next()) diff += u->
value;
1527 for (u = b; u !=
nullptr; u = u->
Next()) diff -= u->
value;
1529 int r = ClampTo<int32_t>(diff);
1530 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1537 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1541static bool VehicleTimeToLiveSorter(
const Vehicle *
const &a,
const Vehicle *
const &b)
1544 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1548static bool VehicleTimetableDelaySorter(
const Vehicle *
const &a,
const Vehicle *
const &b)
1551 return (r != 0) ? r < 0 : VehicleNumberSorter(a, b);
1598static constexpr NWidgetPart _nested_vehicle_list[] = {
1634 NWidget(
WWT_MATRIX, COLOUR_GREY,
WID_VL_LIST),
SetMinimalSize(248, 0),
SetFill(1, 0),
SetResize(1, 1),
SetMatrixDataTip(1, 0),
SetScrollbar(
WID_VL_SCROLLBAR),
1642 SetToolTip(STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
1645 SetStringTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
1647 SetSpriteTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
1649 SetSpriteTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
1658static void DrawSmallOrderList(
const Vehicle *v,
int left,
int right,
int y, uint order_arrow_width,
VehicleOrderID start)
1660 auto orders = v->Orders();
1661 if (orders.empty())
return;
1664 int l_offset = rtl ? 0 : order_arrow_width;
1665 int r_offset = rtl ? order_arrow_width : 0;
1672 if (orders[oid].IsType(OT_GOTO_STATION)) {
1676 if (++i == 4)
break;
1680 }
while (oid != start);
1684static void DrawSmallOrderList(
const OrderList *orderlist,
int left,
int right,
int y, uint order_arrow_width)
1686 if (orderlist ==
nullptr)
return;
1689 int l_offset = rtl ? 0 : order_arrow_width;
1690 int r_offset = rtl ? order_arrow_width : 0;
1693 for (
const Order &order : orderlist->GetOrders()) {
1694 if (order.IsType(OT_GOTO_STATION)) {
1698 if (++i == 4)
break;
1717 default: NOT_REACHED();
1734 if (divisor == 1)
return base;
1737 uint rem = base % divisor;
1738 return base + (rem == 0 ? 0 : divisor - rem);
1769 int image_left = (rtl && show_orderlist) ? olr.right : tr.left;
1770 int image_right = (!rtl && show_orderlist) ? olr.left : tr.right;
1772 int vehicle_button_x = rtl ? ir.right - profit.width : ir.left;
1775 for (
auto it = first; it != last; ++it) {
1780 vehgroup.GetDisplayProfitThisYear(),
1781 vehgroup.GetDisplayProfitLastYear()));
1787 const Vehicle *v = vehgroup.GetSingleVehicle();
1797 CargoTypes vehicle_cargoes = 0;
1799 for (
auto u = v; u !=
nullptr; u = u->
Next()) {
1805 if (!v->
name.empty()) {
1808 GetString(STR_VEHICLE_LIST_NAME_AND_CARGO, STR_VEHICLE_NAME, v->
index, STR_VEHICLE_LIST_CARGO, vehicle_cargoes),
1813 GetString(STR_VEHICLE_LIST_NAME_AND_CARGO, STR_GROUP_NAME, v->
group_id, STR_VEHICLE_LIST_CARGO, vehicle_cargoes),
1819 }
else if (!v->
name.empty()) {
1840 case GB_SHARED_ORDERS:
1841 assert(vehgroup.NumVehicles() > 0);
1843 for (
int i = 0; i < static_cast<int>(vehgroup.NumVehicles()); ++i) {
1861void BaseVehicleListWindow::UpdateSortingFromGrouping()
1871 default: NOT_REACHED();
1879void BaseVehicleListWindow::UpdateVehicleGroupBy(GroupBy group_by)
1888 this->UpdateSortingFromGrouping();
1920 this->GetWidget<NWidgetCore>(
WID_VL_LIST)->SetToolTip(STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.
vtype);
1931 this->GetWidget<NWidgetCore>(
WID_VL_CAPTION)->SetString(STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.
vtype);
1938 this->BuildVehicleList();
1939 this->SortVehicleList();
1953 switch (this->vli.
vtype) {
1956 size.height = 6 *
resize.height;
1960 size.height = 4 *
resize.height;
1962 default: NOT_REACHED();
1969 d.height += padding.height;
1980 size.width = std::max(size.width,
GetStringListWidth(this->vehicle_group_none_sorter_names_wallclock));
1981 size.width = std::max(size.width,
GetStringListWidth(this->vehicle_group_shared_orders_sorter_names_calendar));
1982 size.width = std::max(size.width,
GetStringListWidth(this->vehicle_group_shared_orders_sorter_names_wallclock));
1983 size.width += padding.width;
1992 d.height += padding.height;
1993 d.width += padding.width;
2004 return GetString(STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.
vtype);
2017 switch (this->vli.
type) {
2022 return GetString(stringid, STR_COMPANY_NAME, this->vli.ToCompanyID(), std::monostate{}, this->vehicles.size());
2028 return GetString(stringid, STR_DEPOT_CAPTION, this->vli.
vtype, this->vli.ToDestinationID(), this->vehicles.size());
2030 default: NOT_REACHED();
2055 this->BuildVehicleList();
2056 this->SortVehicleList();
2081 bool last_overlay_state =
false;
2096 ShowOrdersWindow(this->
vehicles[0]);
2119 if (it == this->
vehgroups.end())
return;
2124 const Vehicle *v = vehgroup.GetSingleVehicle();
2135 case GB_SHARED_ORDERS: {
2136 assert(vehgroup.NumVehicles() > 0);
2140 ShowOrdersWindow(v);
2142 if (vehgroup.NumVehicles() == 1) {
2145 ShowVehicleListWindow(v);
2152 default: NOT_REACHED();
2178 this->UpdateVehicleGroupBy(
static_cast<GroupBy
>(index));
2201 case ADI_CREATE_GROUP:
2205 default: NOT_REACHED();
2209 default: NOT_REACHED();
2219 Debug(misc, 3,
"Periodic resort {} list company {} at station {}", this->vli.
vtype, this->owner, station);
2234 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
2238 this->vli.SetIndex(
GB(data, 0, 20));
2255 WDP_AUTO,
"list_vehicles_train", 325, 246,
2258 _nested_vehicle_list
2261 WDP_AUTO,
"list_vehicles_roadveh", 260, 246,
2264 _nested_vehicle_list
2267 WDP_AUTO,
"list_vehicles_ship", 260, 246,
2270 _nested_vehicle_list
2273 WDP_AUTO,
"list_vehicles_aircraft", 260, 246,
2276 _nested_vehicle_list
2284 assert(vehicle_type < std::size(_vehicle_list_desc));
2286 AllocateWindowDescFront<VehicleListWindow>(_vehicle_list_desc[vehicle_type], vli.
ToWindowNumber(), vli);
2299 ShowVehicleListWindowLocal(company,
VL_STANDARD, vehicle_type, company.base());
2303void ShowVehicleListWindow(
const Vehicle *v)
2310 ShowVehicleListWindowLocal(company,
VL_STATION_LIST, vehicle_type, station.base());
2343 SetStringTip(STR_EMPTY, STR_SERVICE_INTERVAL_DROPDOWN_TOOLTIP),
2360 NWidget(
WWT_MATRIX, COLOUR_GREY,
WID_VD_MATRIX),
SetResize(1, 1),
SetMinimalSize(393, 45),
SetMatrixDataTip(1, 0),
SetFill(1, 0),
SetScrollbar(
WID_VD_SCROLLBAR),
2369 SetStringTip(STR_EMPTY, STR_SERVICE_INTERVAL_DROPDOWN_TOOLTIP),
2392static const StringID _service_interval_dropdown_calendar[] = {
2393 STR_VEHICLE_DETAILS_DEFAULT,
2394 STR_VEHICLE_DETAILS_DAYS,
2395 STR_VEHICLE_DETAILS_PERCENT,
2398static const StringID _service_interval_dropdown_wallclock[] = {
2399 STR_VEHICLE_DETAILS_DEFAULT,
2400 STR_VEHICLE_DETAILS_MINUTES,
2401 STR_VEHICLE_DETAILS_PERCENT,
2426 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
2433 if (!gui_scope)
return;
2439 if (aimed_height != nwid_info->
current_y) {
2452 uint desired_height;
2457 for (
const Vehicle *u = v; u !=
nullptr; u = u->
Next()) {
2463 return desired_height;
2481 size.width = dim.width + padding.width;
2508 size.height = 4 *
resize.height;
2513 d.width += padding.width;
2514 d.height += padding.height;
2529 size.width += padding.width;
2541 switch (vehicle_type) {
2542 default: NOT_REACHED();
2566 default: NOT_REACHED();
2669 GetString(v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_MINUTES,
2670 v->GetServiceInterval(), STR_VEHICLE_DETAILS_LAST_SERVICE_MINUTES_AGO, minutes_since_serviced));
2676 GetString(v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS,
2699 !v->ServiceIntervalIsCustom() ? STR_VEHICLE_DETAILS_DEFAULT :
2700 v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_PERCENT :
2723 if (mod == v->GetServiceInterval())
return;
2733 v->ServiceIntervalIsCustom() ? (v->ServiceIntervalIsPercent() ? 2 : 1) : 0, widget, 0, 0);
2758 if (v->ServiceIntervalIsPercent()) {
2759 tool_tip = widget ==
WID_VD_INCREASE_SERVICING_INTERVAL ? STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP_PERCENT : STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP_PERCENT;
2761 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 tool_tip = widget ==
WID_VD_INCREASE_SERVICING_INTERVAL ? STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP_DAYS : STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP_DAYS;
2777 bool iscustom = index != 0;
2778 bool ispercent = iscustom ? (index == 2) :
Company::Get(v->
owner)->settings.vehicle.servint_ispercent;
2789 if (nwi !=
nullptr) {
2797 WDP_AUTO,
"view_vehicle_details_train", 405, 178,
2805 WDP_AUTO,
"view_vehicle_details", 405, 113,
2847 SetSpriteTip(SPR_IGNORE_SIGNALS, STR_VEHICLE_VIEW_TRAIN_IGNORE_SIGNAL_TOOLTIP),
2851 SetSpriteTip(SPR_FORCE_VEHICLE_TURN, STR_VEHICLE_VIEW_ROAD_VEHICLE_REVERSE_TOOLTIP),
2881static const int VV_INITIAL_VIEWPORT_WIDTH = 226;
2882static const int VV_INITIAL_VIEWPORT_HEIGHT = 84;
2883static const int VV_INITIAL_VIEWPORT_HEIGHT_TRAIN = 102;
2887 VCT_CMD_START_STOP = 0,
2889 VCT_CMD_TURN_AROUND,
2895 STR_ERROR_CAN_T_STOP_START_TRAIN,
2896 STR_ERROR_CAN_T_STOP_START_ROAD_VEHICLE,
2897 STR_ERROR_CAN_T_STOP_START_SHIP,
2898 STR_ERROR_CAN_T_STOP_START_AIRCRAFT
2901 STR_ERROR_CAN_T_BUY_TRAIN,
2902 STR_ERROR_CAN_T_BUY_ROAD_VEHICLE,
2903 STR_ERROR_CAN_T_BUY_SHIP,
2904 STR_ERROR_CAN_T_BUY_AIRCRAFT
2907 STR_ERROR_CAN_T_REVERSE_DIRECTION_TRAIN,
2908 STR_ERROR_CAN_T_MAKE_ROAD_VEHICLE_TURN,
2921 if (result.
Failed())
return;
2968 bool mouse_over_start_stop =
false;
2999 static const SpriteID vehicle_view_goto_depot_sprites[] = {
3000 SPR_SEND_TRAIN_TODEPOT,
3001 SPR_SEND_ROADVEH_TODEPOT,
3002 SPR_SEND_SHIP_TODEPOT,
3003 SPR_SEND_AIRCRAFT_TODEPOT,
3006 this->GetWidget<NWidgetCore>(
WID_VV_GOTO_DEPOT)->SetSprite(vehicle_view_goto_depot_sprites[v->
type]);
3009 static const SpriteID vehicle_view_clone_sprites[] = {
3015 this->GetWidget<NWidgetCore>(
WID_VV_CLONE)->SetSprite(vehicle_view_clone_sprites[v->
type]);
3019 this->GetWidget<NWidgetCore>(
WID_VV_TURN_AROUND)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_REVERSE_TOOLTIP);
3030 default: NOT_REACHED();
3036 this->GetWidget<NWidgetCore>(
WID_VV_START_STOP)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_STATUS_START_STOP_TOOLTIP + v->
type);
3037 this->GetWidget<NWidgetCore>(
WID_VV_RENAME)->SetToolTip(STR_VEHICLE_DETAILS_TRAIN_RENAME + v->
type);
3038 this->GetWidget<NWidgetCore>(
WID_VV_LOCATION)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_CENTER_TOOLTIP + v->
type);
3039 this->GetWidget<NWidgetCore>(
WID_VV_REFIT)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_REFIT_TOOLTIP + v->
type);
3040 this->GetWidget<NWidgetCore>(
WID_VV_GOTO_DEPOT)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_SEND_TO_DEPOT_TOOLTIP + v->
type);
3041 this->GetWidget<NWidgetCore>(
WID_VV_SHOW_ORDERS)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_ORDERS_TOOLTIP + v->
type);
3042 this->GetWidget<NWidgetCore>(
WID_VV_SHOW_DETAILS)->SetToolTip(STR_VEHICLE_VIEW_TRAIN_SHOW_DETAILS_TOOLTIP + v->
type);
3043 this->GetWidget<NWidgetCore>(
WID_VV_CLONE)->SetToolTip(STR_VEHICLE_VIEW_CLONE_TRAIN_INFO + v->
type);
3045 this->UpdateButtonStatus();
3048 void Close([[maybe_unused]]
int data = 0)
override
3073 size.width = VV_INITIAL_VIEWPORT_WIDTH;
3074 size.height = (v->
type ==
VEH_TRAIN) ? VV_INITIAL_VIEWPORT_HEIGHT_TRAIN : VV_INITIAL_VIEWPORT_HEIGHT;
3117 std::string GetVehicleStatusString(
const Vehicle *v,
TextColour &text_colour)
const
3119 text_colour = TC_BLACK;
3128 if (
Train::From(v)->gcache.cached_power == 0)
return GetString(STR_VEHICLE_STATUS_TRAIN_NO_POWER);
3129 return GetString(STR_VEHICLE_STATUS_STOPPED);
3139 if (mouse_over_start_stop) {
3148 case OT_GOTO_STATION:
3150 v->current_order.GetDestination(),
PackVelocity(v->GetDisplaySpeed(), v->type));
3152 case OT_GOTO_DEPOT: {
3174 return GetString(STR_VEHICLE_STATUS_LOADING_UNLOADING);
3176 case OT_GOTO_WAYPOINT:
3179 v->current_order.GetDestination(),
PackVelocity(v->GetDisplaySpeed(), v->type));
3181 case OT_LEAVESTATION:
3183 return GetString(STR_VEHICLE_STATUS_LEAVING);
3207 DrawSpriteIgnorePadding(image, PAL_NONE, tr.WithWidth(icon_width, rtl),
SA_CENTER);
3212 std::string str = GetVehicleStatusString(v, text_colour);
3249 if (click_count > 1) {
3253 if (mainwindow->
viewport->follow_vehicle == v->
index) mainwindow->
viewport->follow_vehicle = VehicleID::Invalid();
3269 ShowOrdersWindow(v);
3319 if (!str.has_value())
return;
3327 if (start_stop != mouse_over_start_stop) {
3328 mouse_over_start_stop = start_stop;
3349 void UpdateButtonStatus()
3379 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
3387 this->UpdateButtonStatus();
3400 static inline HotkeyList hotkeys{
"vehicleview", {
3407 WDP_AUTO,
"view_vehicle", 250, 116,
3411 &VehicleViewWindow::hotkeys
3419 WDP_AUTO,
"view_vehicle_train", 250, 134,
3423 &VehicleViewWindow::hotkeys
3439 assert(v !=
nullptr);
3454bool VehicleClicked(VehicleList::const_iterator begin, VehicleList::const_iterator end)
3456 assert(begin != end);
3475void StopGlobalFollowVehicle(
const Vehicle *v)
3492 if (result.
Failed())
return;
3530 int vehicle_width = 0;
3531 for (
const Vehicle *u = v; u !=
nullptr; u = u->
Next()) {
3534 return vehicle_width;
3550 int total_width = 0;
3552 bool rotor_seq =
false;
3555 while (v !=
nullptr) {
3556 if (total_width >=
ScaleSpriteTrad(2 * (
int)VEHICLEINFO_FULL_VEHICLE_WIDTH))
break;
3563 if (!seq.
IsValid()) seq.
Set(SPR_ROTOR_STOPPED);
3572 for (uint i = 0; i < seq.count; ++i) {
3574 _cursor.
sprites.emplace_back(seq.seq[i].sprite, pal2, rtl ? (-total_width + x_offs) : (total_width + x_offs), y_offset);
3586 if (is_ground_vehicle) {
3588 int offs = (
ScaleSpriteTrad(VEHICLEINFO_FULL_VEHICLE_WIDTH) - total_width) / 2;
3589 if (rtl) offs = -offs;
3590 for (
auto &cs : _cursor.
sprites) {
@ VAF_DEST_TOO_FAR
Next destination is too far away.
@ AIR_HELICOPTER
an helicopter
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.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
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 HasAtMostOneBit(T value)
Test whether value has at most 1 bit set.
debug_inline static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
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.
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
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.
bool CanCarryCargo() const
Determines whether an engine can carry something.
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
void RebuildDone()
Notify the sortlist that the rebuild is done.
void SetListing(Listing l)
Import sort conditions.
void SetFilterState(bool state)
Enable or disable the filter.
bool IsDescSortOrder() const
Check if the sort order is descending.
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here.
bool(const GUIVehicleGroup *, CargoType) FilterFunction
Signature of filter function.
void SetFilterFuncs(std::span< FilterFunction *const > n_funcs)
Hand the filter function pointers to the GUIList.
bool NeedRebuild() const
Check if a rebuild is needed.
void SetFilterType(uint8_t n_type)
Set the filtertype of the list.
void ForceRebuild()
Force that a rebuild is needed.
bool Sort(Comp compare)
Sort the list.
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
uint8_t SortType() const
Get the sorttype of the list.
Listing GetListing() const
Export current sort conditions.
void SetSortFuncs(std::span< SortFunction *const > n_funcs)
Hand the sort function pointers to the GUIList.
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
void SetSortType(uint8_t n_type)
Set the sorttype of 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
The date of the last day of the max year.
static constexpr int DAYS_IN_YEAR
days per year
static constexpr TimerGame< struct Economy >::Year MAX_YEAR
MAX_YEAR, nicely rounded value of the number of years that can be encoded in a single 32 bits date,...
static constexpr int DAYS_IN_LEAP_YEAR
sometimes, you need one day more...
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)
Calculate the year of a given date.
static constexpr Date DateAtStartOfYear(Year year)
Calculate the date of the first day of a given year.
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.
Command definitions related to depots.
void CcCloneVehicle(Commands cmd, 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'.
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.
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
Dimension GetDropDownListDimension(const DropDownList &list)
Determine width and height required to fully display a DropDownList.
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.
Functions related to engines.
@ AutoRefit
Automatic refitting is allowed.
@ Maglev
Maglev acceleration model.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
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.
void UpdateCursorSize()
Update cursor dimension.
bool _shift_pressed
Is Shift pressed?
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Dimension GetStringListBoundingBox(std::span< const StringID > list, FontSize fontsize)
Get maximum dimension of a list of strings.
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.
bool _ctrl_pressed
Is Ctrl pressed?
uint GetStringListWidth(std::span< const StringID > list, FontSize fontsize)
Get maximum width of a list of strings.
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
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.
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
@ FS_SMALL
Index of the small font in the font tables.
@ FS_NORMAL
Index of the normal font in the font tables.
@ SA_LEFT
Left align the text.
@ SA_HOR_CENTER
Horizontally center the text.
@ SA_CENTER
Center both horizontally and vertically.
uint32_t PaletteID
The number of the palette.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
@ TC_FORCED
Ignore colour changes from strings.
Command definitions related to engine groups.
void CcAddVehicleNewGroup(Commands cmd, const CommandCost &result, GroupID new_group, GroupID, VehicleID veh_id, 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)
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.
static constexpr GroupID ALL_GROUP
All vehicles are in this group.
static constexpr GroupID NEW_GROUP
Sentinel for a to-be-created group.
GUI functions that shouldn't be here.
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Hotkey related 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.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
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.
void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
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.
static constexpr CargoType CF_NONE
Show only items which do not carry cargo (e.g. train engines)
static constexpr CargoType CF_ANY
Show all items independent of carried cargo (i.e. no filtering)
@ 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.
static constexpr GRFStringID GRFSTR_MISC_GRF_TEXT
Miscellaneous GRF text range.
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)
@ ODATFB_UNBUNCH
Service the vehicle and then unbunch it.
@ ODATFB_HALT
Service the vehicle and then halt it.
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
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.
ClientSettings _settings_client
The current settings for this game.
@ SWS_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.
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 color by black, needed for painting fictive tiles outside map.
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
static const SpriteID SPR_CLONE_TRAIN
Clone vehicles stuff.
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.
Functions related to low-level strings.
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
Get some number that is suitable for string size computations.
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.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
TextDirection _current_text_dir
Text direction of the currently selected language.
uint64_t GetParamMaxDigits(uint count, FontSize size)
Get some number that is suitable for string size computations.
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.
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.
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.
void SetCargoFilter(uint8_t index)
Set cargo filter for the vehicle group list.
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.
Specification of a cargo type.
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
StringID name
Name of this type of cargo.
Comparator to sort CargoType by according to desired order.
GUISettings gui
settings related to the GUI
std::vector< CursorSprite > sprites
Sprites comprising cursor.
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.
bool show_cargo_in_vehicle_lists
Show the cargoes the vehicles can carry in the list windows.
uint8_t scrollwheel_scrolling
scrolling using the scroll wheel?
uint8_t advanced_vehicle_list
use the "advanced" vehicle list
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.
VehicleSettings vehicle
options for vehicles
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.
All data for a single hotkey.
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
VehicleOrderID GetNext(VehicleOrderID cur) const
Get the order after the given one or the first one, if the given one is the last one.
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.
bool IsType(OrderType type) const
Check whether this order is of the given type.
OrderType GetType() const
Get the type of order of this order.
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Colour for pixel/line drawing.
static Titem * Get(auto index)
Returns Titem with given index.
Tindex index
Index of this pool item.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
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.
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.
uint step_height
Step-size of height resize changes.
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
T * Next() const
Get next vehicle in the chain.
static T * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Templated helper to make a type-safe 'typedef' representing a single POD value.
Window * GetCallbackWnd()
Get the window that started the current highlighting.
HighLightStyle place_mode
Method which is used to place the selection.
WindowClass window_class
The WindowClass of the window that is responsible for the selection mode.
WindowNumber window_number
The WindowNumber of the window that is responsible for the selection mode.
'Train' is either a loco or a wagon.
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
Class for managing the vehicle details window.
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.
VehicleListType type
The type of vehicle list.
CompanyID company
The company associated with this list.
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.
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.
uint8_t roadveh_acceleration_model
realistic acceleration for road vehicles
uint8_t train_acceleration_model
realistic acceleration for trains
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.
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 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 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?
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.
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.
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.
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.
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.
GroundVehicleCache * GetGroundVehicleCache()
Access the ground vehicle cache of the vehicle.
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.
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.
debug_inline bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
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.
Number to differentiate different windows of the same class.
Data structure for an opened window.
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
void DrawWidgets() const
Paint all widgets of a window.
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Window * parent
Parent window.
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
void DrawSortButtonState(WidgetID widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
ResizeInfo resize
Resize information.
virtual bool OnVehicleSelect(const struct Vehicle *v)
The user clicked on a vehicle while HT_VEHICLE has been set.
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
int left
x position of left edge of the window
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
WindowFlags flags
Window flags.
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
int height
Height of the window (number of pixels down in y direction)
int width
width of the window (number of pixels to the right in x direction)
WindowNumber window_number
Window number within the window class.
Stuff related to the text buffer GUI.
@ TE_RISING
Make the text effect slowly go upwards.
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
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)
Base for the train class.
@ Stuck
Train can't get a path reservation.
@ TFP_SIGNAL
Ignore next signal, after the signal ignore being stuck.
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.
PaletteID GetVehiclePalette(const Vehicle *v)
Get the colour map for a vehicle.
void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8_t num_vehicles)
Calculates the set of vehicles that will be affected by a given selection.
@ Crashed
Vehicle is crashed.
@ Stopped
Vehicle is stopped by the player.
Command definitions for vehicles.
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.
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.
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.
static constexpr NWidgetPart _nested_vehicle_view_widgets[]
Vehicle view widgets.
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 constexpr NWidgetPart _nested_nontrain_vehicle_details_widgets[]
Vehicle details widgets (other than train).
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 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 CMD_START_STOP_VEHICLE for given vehicle.
static constexpr NWidgetPart _nested_train_vehicle_details_widgets[]
Train details widgets.
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 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.
@ VIWD_AUTOREPLACE
Autoreplace replaced the vehicle.
uint GetVehicleHeight(VehicleType type)
Get the height of a single vehicle in the GUIs.
TrainDetailsWindowTabs
The tabs in the train details window.
@ TDW_TAB_CAPACITY
Tab with cargo capacity of the vehicles.
@ TDW_TAB_TOTALS
Tab with sum of total cargo transported.
@ TDW_TAB_INFO
Tab with name and value of the vehicles.
@ TDW_TAB_CARGO
Tab with cargo carried by the vehicles.
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, ...
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'.
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.
VehicleListType
Vehicle List type flags.
@ VL_STANDARD
Index is the company.
@ VL_STATION_LIST
Index is the station.
@ VL_DEPOT_LIST
Index is the destination (station for hangar of aircraft, depot for others)
@ VL_SHARED_ORDERS
Index is the first vehicle of the shared orders.
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 CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Window * GetMainWindow()
Get the main window, i.e.
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
@ Construction
This window is used for construction; close it whenever changing company.
@ BorderOnly
Draw border only, no background.
@ DisableVpScroll
Window does not do autoscroll,.
@ SBS_DOWN
Sort ascending.
@ WDP_AUTO
Find a place automatically.
EventState
State of handling an event.
WindowClass
Window classes.
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
@ 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.
ZoomLevel ScaleZoomGUI(ZoomLevel value)
Scale zoom level relative to GUI zoom.
int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
ZoomLevel
All zoom levels we know.
@ Ship
Default zoom level for the ship view.
@ RoadVehicle
Default zoom level for the road vehicle view.
@ Aircraft
Default zoom level for the aircraft view.
@ Train
Default zoom level for the train view.