From daf6656f4938ea160706fe7719dcbe409f3fc358 Mon Sep 17 00:00:00 2001 From: Peter Nelson Date: Thu, 29 May 2025 01:20:35 +0100 Subject: [PATCH] Add: Industry accepted and waiting history. Records amount of cargo accepted, and a rolling average of the waiting amount. Average waiting samples the waiting amount once per day for each industry, spread out over an economy day. --- src/economy.cpp | 1 + src/graph_gui.cpp | 28 +++++++++++++++++++++++-- src/industry.h | 8 +++++++ src/industry_cmd.cpp | 10 +++++++++ src/industry_gui.cpp | 4 ++-- src/lang/english.txt | 8 ++++--- src/misc/history_func.hpp | 11 ++++++++++ src/saveload/industry_sl.cpp | 36 ++++++++++++++++++++++++++++++++ src/saveload/saveload.h | 2 ++ src/timer/timer_game_economy.cpp | 4 ++++ src/timer/timer_game_economy.h | 2 ++ 11 files changed, 107 insertions(+), 7 deletions(-) diff --git a/src/economy.cpp b/src/economy.cpp index 9d428bc07c..efe28b2a18 100644 --- a/src/economy.cpp +++ b/src/economy.cpp @@ -1070,6 +1070,7 @@ static uint DeliverGoodsToIndustry(const Station *st, CargoType cargo_type, uint uint amount = std::min(num_pieces, 0xFFFFu - it->waiting); it->waiting += amount; + it->history[THIS_MONTH].accepted += amount; it->last_accepted = TimerGameEconomy::date; num_pieces -= amount; accepted += amount; diff --git a/src/graph_gui.cpp b/src/graph_gui.cpp index 85fbc54bbb..000d96f15c 100644 --- a/src/graph_gui.cpp +++ b/src/graph_gui.cpp @@ -1604,7 +1604,9 @@ CompanyID PerformanceRatingDetailWindow::company = CompanyID::Invalid(); struct IndustryProductionGraphWindow : BaseCargoGraphWindow { static inline constexpr StringID RANGE_LABELS[] = { STR_GRAPH_INDUSTRY_RANGE_PRODUCED, - STR_GRAPH_INDUSTRY_RANGE_TRANSPORTED + STR_GRAPH_INDUSTRY_RANGE_TRANSPORTED, + STR_GRAPH_INDUSTRY_RANGE_DELIVERED, + STR_GRAPH_INDUSTRY_RANGE_WAITING, }; static inline CargoTypes excluded_cargo_types{}; @@ -1626,6 +1628,9 @@ struct IndustryProductionGraphWindow : BaseCargoGraphWindow { { CargoTypes cargo_types{}; const Industry *i = Industry::Get(window_number); + for (const auto &a : i->accepted) { + if (IsValidCargoType(a.cargo)) SetBit(cargo_types, a.cargo); + } for (const auto &p : i->produced) { if (IsValidCargoType(p.cargo)) SetBit(cargo_types, p.cargo); } @@ -1639,7 +1644,7 @@ struct IndustryProductionGraphWindow : BaseCargoGraphWindow { std::string GetWidgetString(WidgetID widget, StringID stringid) const override { - if (widget == WID_GRAPH_CAPTION) return GetString(STR_GRAPH_INDUSTRY_PRODUCTION_CAPTION, this->window_number); + if (widget == WID_GRAPH_CAPTION) return GetString(STR_GRAPH_INDUSTRY_CAPTION, this->window_number); return this->Window::GetWidgetString(widget, stringid); } @@ -1683,6 +1688,25 @@ struct IndustryProductionGraphWindow : BaseCargoGraphWindow { transported.Fill(p.history, &Industry::ProducedHistory::transported); } + for (const auto &a : i->accepted) { + if (!IsValidCargoType(a.cargo)) continue; + const CargoSpec *cs = CargoSpec::Get(a.cargo); + + DataSet &accepted = this->data.emplace_back(); + accepted.colour = cs->legend_colour; + accepted.exclude_bit = cs->Index(); + accepted.range_bit = 2; + accepted.dash = 1; + accepted.Fill(a.history, &Industry::AcceptedHistory::accepted); + + DataSet &waiting = this->data.emplace_back(); + waiting.colour = cs->legend_colour; + waiting.exclude_bit = cs->Index(); + waiting.range_bit = 3; + waiting.dash = 4; + waiting.Fill(a.history, &Industry::AcceptedHistory::waiting); + } + this->SetDirty(); } }; diff --git a/src/industry.h b/src/industry.h index 29d8756948..1d694d03e1 100644 --- a/src/industry.h +++ b/src/industry.h @@ -77,10 +77,18 @@ struct Industry : IndustryPool::PoolItem<&_industry_pool> { HistoryData history{}; ///< History of cargo produced and transported for this month and 24 previous months }; + struct AcceptedHistory { + uint16_t accepted = 0; /// Total accepted. + uint16_t waiting = 0; /// Average waiting. + }; + struct AcceptedCargo { CargoType cargo = 0; ///< Cargo type uint16_t waiting = 0; ///< Amount of cargo waiting to processed + uint32_t accumulated_waiting = 0; ///< Accumulated waiting total over the last month. TimerGameEconomy::Date last_accepted{}; ///< Last day cargo was accepted by this industry + + HistoryData history{}; ///< History of accepted ccargo. }; using ProducedCargoes = std::vector; diff --git a/src/industry_cmd.cpp b/src/industry_cmd.cpp index 1989a49d49..cdfb4eb8f5 100644 --- a/src/industry_cmd.cpp +++ b/src/industry_cmd.cpp @@ -1245,6 +1245,10 @@ void OnTick_Industry() for (Industry *i : Industry::Iterate()) { ProduceIndustryGoods(i); + + if ((TimerGameTick::counter + i->index) % Ticks::DAY_TICKS == 0) { + for (auto &a : i->accepted) a.accumulated_waiting += a.waiting; + } } } @@ -2502,6 +2506,12 @@ static void UpdateIndustryStatistics(Industry *i) RotateHistory(p.history); } } + + for (auto &a : i->accepted) { + if (!IsValidCargoType(a.cargo)) continue; + a.history[THIS_MONTH].waiting = GetAndResetAccumulatedAverage(a.accumulated_waiting); + RotateHistory(a.history); + } } /** diff --git a/src/industry_gui.cpp b/src/industry_gui.cpp index b8af1ad201..5ca436e279 100644 --- a/src/industry_gui.cpp +++ b/src/industry_gui.cpp @@ -845,7 +845,7 @@ public: nvp->InitializeViewport(this, Industry::Get(window_number)->location.GetCenterTile(), ScaleZoomGUI(ZoomLevel::Industry)); const Industry *i = Industry::Get(window_number); - if (!i->IsCargoProduced()) this->DisableWidget(WID_IV_GRAPH); + if (!i->IsCargoProduced() && !i->IsCargoAccepted()) this->DisableWidget(WID_IV_GRAPH); this->InvalidateData(); } @@ -1242,7 +1242,7 @@ static constexpr NWidgetPart _nested_industry_view_widgets[] = { EndContainer(), NWidget(NWID_HORIZONTAL), NWidget(WWT_PUSHTXTBTN, COLOUR_CREAM, WID_IV_DISPLAY), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_INDUSTRY_DISPLAY_CHAIN, STR_INDUSTRY_DISPLAY_CHAIN_TOOLTIP), - NWidget(WWT_PUSHTXTBTN, COLOUR_CREAM, WID_IV_GRAPH), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_INDUSTRY_VIEW_PRODUCTION_GRAPH, STR_INDUSTRY_VIEW_PRODUCTION_GRAPH_TOOLTIP), + NWidget(WWT_PUSHTXTBTN, COLOUR_CREAM, WID_IV_GRAPH), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_INDUSTRY_VIEW_CARGO_GRAPH, STR_INDUSTRY_VIEW_CARGO_GRAPH_TOOLTIP), NWidget(WWT_RESIZEBOX, COLOUR_CREAM), EndContainer(), }; diff --git a/src/lang/english.txt b/src/lang/english.txt index 21d0e08940..c6267f19ad 100644 --- a/src/lang/english.txt +++ b/src/lang/english.txt @@ -633,9 +633,11 @@ STR_GRAPH_CARGO_TOOLTIP_DISABLE_ALL :{BLACK}Display STR_GRAPH_CARGO_PAYMENT_TOGGLE_CARGO :{BLACK}Toggle graph of this cargo type STR_GRAPH_CARGO_PAYMENT_CARGO :{TINY_FONT}{BLACK}{STRING} -STR_GRAPH_INDUSTRY_PRODUCTION_CAPTION :{WHITE}{INDUSTRY} - Production History +STR_GRAPH_INDUSTRY_CAPTION :{WHITE}{INDUSTRY} - Cargo History STR_GRAPH_INDUSTRY_RANGE_PRODUCED :Produced STR_GRAPH_INDUSTRY_RANGE_TRANSPORTED :Transported +STR_GRAPH_INDUSTRY_RANGE_DELIVERED :Delivered +STR_GRAPH_INDUSTRY_RANGE_WAITING :Waiting STR_GRAPH_PERFORMANCE_DETAIL_TOOLTIP :{BLACK}Show detailed performance ratings @@ -4031,8 +4033,8 @@ STR_INDUSTRY_VIEW_PRODUCTION_LAST_MONTH_TITLE :{BLACK}Producti STR_INDUSTRY_VIEW_PRODUCTION_LAST_MINUTE_TITLE :{BLACK}Production last minute: STR_INDUSTRY_VIEW_TRANSPORTED :{YELLOW}{CARGO_LONG}{RAW_STRING}{BLACK} ({COMMA}% transported) STR_INDUSTRY_VIEW_LOCATION_TOOLTIP :{BLACK}Centre the main view on industry location. Ctrl+Click to open a new viewport on industry location -STR_INDUSTRY_VIEW_PRODUCTION_GRAPH :{BLACK}Production Graph -STR_INDUSTRY_VIEW_PRODUCTION_GRAPH_TOOLTIP :{BLACK}Shows the graph of industry production history +STR_INDUSTRY_VIEW_CARGO_GRAPH :{BLACK}Cargo Graph +STR_INDUSTRY_VIEW_CARGO_GRAPH_TOOLTIP :{BLACK}Shows the graph of industry cargo history STR_INDUSTRY_VIEW_PRODUCTION_LEVEL :{BLACK}Production level: {YELLOW}{COMMA}% STR_INDUSTRY_VIEW_INDUSTRY_ANNOUNCED_CLOSURE :{YELLOW}The industry has announced imminent closure! diff --git a/src/misc/history_func.hpp b/src/misc/history_func.hpp index 059d9c70c8..6af9e63571 100644 --- a/src/misc/history_func.hpp +++ b/src/misc/history_func.hpp @@ -10,6 +10,9 @@ #ifndef HISTORY_FUNC_HPP #define HISTORY_FUNC_HPP +#include "../core/math_func.hpp" + +#include "../timer/timer_game_economy.h" #include "history_type.hpp" /** @@ -24,4 +27,12 @@ void RotateHistory(HistoryData &history) history[THIS_MONTH] = {}; } +template +T GetAndResetAccumulatedAverage(Taccrued &total) +{ + T result = ClampTo(total / std::max(1U, TimerGameEconomy::days_since_last_month)); + total = 0; + return result; +} + #endif /* HISTORY_FUNC_HPP */ diff --git a/src/saveload/industry_sl.cpp b/src/saveload/industry_sl.cpp index 750a729136..eaa776710f 100644 --- a/src/saveload/industry_sl.cpp +++ b/src/saveload/industry_sl.cpp @@ -19,12 +19,48 @@ static OldPersistentStorage _old_ind_persistent_storage; +class SlIndustryAcceptedHistory : public DefaultSaveLoadHandler { +public: + static inline const SaveLoad description[] = { + SLE_VAR(Industry::AcceptedHistory, accepted, SLE_UINT16), + SLE_VAR(Industry::AcceptedHistory, waiting, SLE_UINT16), + }; + static inline const SaveLoadCompatTable compat_description = _industry_produced_history_sl_compat; + + void Save(Industry::AcceptedCargo *a) const override + { + if (!IsValidCargoType(a->cargo)) { + /* Don't save any history if cargo slot isn't used. */ + SlSetStructListLength(0); + return; + } + + SlSetStructListLength(a->history.size()); + + for (auto &h : a->history) { + SlObject(&h, this->GetDescription()); + } + } + + void Load(Industry::AcceptedCargo *a) const override + { + size_t len = SlGetStructListLength(a->history.size()); + + for (auto &h : a->history) { + if (--len > a->history.size()) break; // unsigned so wraps after hitting zero. + SlObject(&h, this->GetDescription()); + } + } +}; + class SlIndustryAccepted : public VectorSaveLoadHandler { public: static inline const SaveLoad description[] = { SLE_VAR(Industry::AcceptedCargo, cargo, SLE_UINT8), SLE_VAR(Industry::AcceptedCargo, waiting, SLE_UINT16), SLE_VAR(Industry::AcceptedCargo, last_accepted, SLE_INT32), + SLE_CONDVAR(Industry::AcceptedCargo, accumulated_waiting, SLE_UINT32, SLV_INDUSTRY_ACCEPTED_HISTORY, SL_MAX_VERSION), + SLEG_CONDSTRUCTLIST("history", SlIndustryAcceptedHistory, SLV_INDUSTRY_ACCEPTED_HISTORY, SL_MAX_VERSION), }; static inline const SaveLoadCompatTable compat_description = _industry_accepts_sl_compat; diff --git a/src/saveload/saveload.h b/src/saveload/saveload.h index ec78153db1..0898ce9d2b 100644 --- a/src/saveload/saveload.h +++ b/src/saveload/saveload.h @@ -403,6 +403,8 @@ enum SaveLoadVersion : uint16_t { SLV_FIX_SCC_ENCODED_NEGATIVE, ///< 353 PR#14049 Fix encoding of negative parameters. SLV_ORDERS_OWNED_BY_ORDERLIST, ///< 354 PR#13948 Orders stored in OrderList, pool removed. + SLV_INDUSTRY_ACCEPTED_HISTORY, ///< 355 PR#14321 Add per-industry history of cargo delivered and waiting. + SL_MAX_VERSION, ///< Highest possible saveload version }; diff --git a/src/timer/timer_game_economy.cpp b/src/timer/timer_game_economy.cpp index 8ac08a1ba2..607c2ae856 100644 --- a/src/timer/timer_game_economy.cpp +++ b/src/timer/timer_game_economy.cpp @@ -37,6 +37,7 @@ TimerGameEconomy::Year TimerGameEconomy::year = {}; TimerGameEconomy::Month TimerGameEconomy::month = {}; TimerGameEconomy::Date TimerGameEconomy::date = {}; TimerGameEconomy::DateFract TimerGameEconomy::date_fract = {}; +uint TimerGameEconomy::days_since_last_month = {}; /** * Converts a Date to a Year, Month & Day. @@ -133,6 +134,7 @@ bool TimerManager::Elapsed([[maybe_unused]] TimerGameEconomy:: /* increase day counter */ TimerGameEconomy::date++; + ++TimerGameEconomy::days_since_last_month; TimerGameEconomy::YearMonthDay ymd = TimerGameEconomy::ConvertDateToYMD(TimerGameEconomy::date); @@ -177,6 +179,8 @@ bool TimerManager::Elapsed([[maybe_unused]] TimerGameEconomy:: } } + if (new_month) TimerGameEconomy::days_since_last_month = 0; + /* check if we reached the maximum year, decrement dates by a year */ if (TimerGameEconomy::year == EconomyTime::MAX_YEAR + 1) { TimerGameEconomy::year--; diff --git a/src/timer/timer_game_economy.h b/src/timer/timer_game_economy.h index 81df5ff179..9c51086e9e 100644 --- a/src/timer/timer_game_economy.h +++ b/src/timer/timer_game_economy.h @@ -37,6 +37,8 @@ public: static Date date; ///< Current date in days (day counter). static DateFract date_fract; ///< Fractional part of the day. + static uint days_since_last_month; ///< Number of days that have elapsed since the last month. + static YearMonthDay ConvertDateToYMD(Date date); static Date ConvertYMDToDate(Year year, Month month, Day day); static void SetDate(Date date, DateFract fract);