Changeset - r26791:8e217aa7f11b
[Not reviewed]
master
0 5 0
SamuXarick - 23 months ago 2023-01-22 13:14:02
43006711+SamuXarick@users.noreply.github.com
Fix 3c047b1: AIGroup.GetProfitLastYear could get values different than those displayed in GUI (#10227)

* Change: Store "all time" and "since minimum age" last year profits on groups

* Fix: Update last year profit for groups when copying vehicle statistics on autoreplace

* Codechange: Refactor profit last year

* Change: Rename some group related items for clarity

* Change: Reorder the fields in GroupStatistics

That way less memory gets wasted.
5 files changed with 55 insertions and 34 deletions:
0 comments (0 inline, 0 general)
src/autoreplace_cmd.cpp
Show inline comments
 
@@ -422,6 +422,7 @@ static CommandCost CopyHeadSpecificThing
 
	if (cost.Succeeded() && old_head != new_head && (flags & DC_EXEC) != 0) {
 
		/* Copy other things which cannot be copied by a command and which shall not stay resetted from the build vehicle command */
 
		new_head->CopyVehicleConfigAndStatistics(old_head);
 
		GroupStatistics::AddProfitLastYear(new_head);
 

	
 
		/* Switch vehicle windows/news to the new vehicle, so they are not closed/deleted when the old vehicle is sold */
 
		ChangeVehicleViewports(old_head->index, new_head->index);
src/group.h
Show inline comments
 
@@ -23,15 +23,14 @@ extern GroupPool _group_pool; ///< Pool 
 

	
 
/** Statistics and caches on the vehicles in a group. */
 
struct GroupStatistics {
 
	uint16 num_vehicle;                     ///< Number of vehicles.
 
	Money profit_last_year;                 ///< Sum of profits for all vehicles.
 
	Money profit_last_year_min_age;         ///< Sum of profits for vehicles considered for profit statistics.
 
	uint16 *num_engines;                    ///< Caches the number of engines of each type the company owns.
 

	
 
	uint16 num_vehicle;                     ///< Number of vehicles.
 
	uint16 num_vehicle_min_age;             ///< Number of vehicles considered for profit statistics;
 
	bool autoreplace_defined;               ///< Are any autoreplace rules set?
 
	bool autoreplace_finished;              ///< Have all autoreplacement finished?
 

	
 
	uint16 num_profit_vehicle;              ///< Number of vehicles considered for profit statistics;
 
	Money profit_last_year;                 ///< Sum of profits for all vehicles.
 

	
 
	GroupStatistics();
 
	~GroupStatistics();
 

	
 
@@ -39,8 +38,10 @@ struct GroupStatistics {
 

	
 
	void ClearProfits()
 
	{
 
		this->num_profit_vehicle = 0;
 
		this->profit_last_year = 0;
 

	
 
		this->num_vehicle_min_age = 0;
 
		this->profit_last_year_min_age = 0;
 
	}
 

	
 
	void ClearAutoreplace()
 
@@ -55,7 +56,8 @@ struct GroupStatistics {
 

	
 
	static void CountVehicle(const Vehicle *v, int delta);
 
	static void CountEngine(const Vehicle *v, int delta);
 
	static void VehicleReachedProfitAge(const Vehicle *v);
 
	static void AddProfitLastYear(const Vehicle *v);
 
	static void VehicleReachedMinAge(const Vehicle *v);
 

	
 
	static void UpdateProfits();
 
	static void UpdateAfterLoad();
 
@@ -104,8 +106,8 @@ static inline bool IsAllGroupID(GroupID 
 

	
 
uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e);
 
uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type);
 
uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type);
 
Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type);
 
uint GetGroupNumVehicleMinAge(CompanyID company, GroupID id_g, VehicleType type);
 
Money GetGroupProfitLastYearMinAge(CompanyID company, GroupID id_g, VehicleType type);
 

	
 
void SetTrainGroupID(Train *v, GroupID grp);
 
void UpdateTrainGroupID(Train *v);
src/group_cmd.cpp
Show inline comments
 
@@ -43,8 +43,9 @@ GroupStatistics::~GroupStatistics()
 
void GroupStatistics::Clear()
 
{
 
	this->num_vehicle = 0;
 
	this->num_profit_vehicle = 0;
 
	this->profit_last_year = 0;
 
	this->num_vehicle_min_age = 0;
 
	this->profit_last_year_min_age = 0;
 

	
 
	/* This is also called when NewGRF change. So the number of engines might have changed. Reallocate. */
 
	free(this->num_engines);
 
@@ -136,13 +137,15 @@ void GroupStatistics::Clear()
 
	GroupStatistics &stats = GroupStatistics::Get(v);
 

	
 
	stats_all.num_vehicle += delta;
 
	stats_all.profit_last_year += v->GetDisplayProfitLastYear() * delta;
 
	stats.num_vehicle += delta;
 
	stats.profit_last_year += v->GetDisplayProfitLastYear() * delta;
 

	
 
	if (v->age > VEHICLE_PROFIT_MIN_AGE) {
 
		stats_all.num_profit_vehicle += delta;
 
		stats_all.profit_last_year += v->GetDisplayProfitLastYear() * delta;
 
		stats.num_profit_vehicle += delta;
 
		stats.profit_last_year += v->GetDisplayProfitLastYear() * delta;
 
		stats_all.num_vehicle_min_age += delta;
 
		stats_all.profit_last_year_min_age += v->GetDisplayProfitLastYear() * delta;
 
		stats.num_vehicle_min_age += delta;
 
		stats.profit_last_year_min_age += v->GetDisplayProfitLastYear() * delta;
 
	}
 
}
 

	
 
@@ -159,20 +162,32 @@ void GroupStatistics::Clear()
 
}
 

	
 
/**
 
 * Add a vehicle to the profit sum of its group.
 
 * Add a vehicle's last year profit to the profit sum of its group.
 
 */
 
/* static */ void GroupStatistics::VehicleReachedProfitAge(const Vehicle *v)
 
/* static */ void GroupStatistics::AddProfitLastYear(const Vehicle *v)
 
{
 
	GroupStatistics &stats_all = GroupStatistics::GetAllGroup(v);
 
	GroupStatistics &stats = GroupStatistics::Get(v);
 

	
 
	stats_all.num_profit_vehicle++;
 
	stats_all.profit_last_year += v->GetDisplayProfitLastYear();
 
	stats.num_profit_vehicle++;
 
	stats.profit_last_year += v->GetDisplayProfitLastYear();
 
}
 

	
 
/**
 
 * Add a vehicle to the profit sum of its group.
 
 */
 
/* static */ void GroupStatistics::VehicleReachedMinAge(const Vehicle *v)
 
{
 
	GroupStatistics &stats_all = GroupStatistics::GetAllGroup(v);
 
	GroupStatistics &stats = GroupStatistics::Get(v);
 

	
 
	stats_all.num_vehicle_min_age++;
 
	stats_all.profit_last_year_min_age += v->GetDisplayProfitLastYear();
 
	stats.num_vehicle_min_age++;
 
	stats.profit_last_year_min_age += v->GetDisplayProfitLastYear();
 
}
 

	
 
/**
 
 * Recompute the profits for all groups.
 
 */
 
/* static */ void GroupStatistics::UpdateProfits()
 
@@ -191,7 +206,10 @@ void GroupStatistics::Clear()
 
	}
 

	
 
	for (const Vehicle *v : Vehicle::Iterate()) {
 
		if (v->IsPrimaryVehicle() && v->age > VEHICLE_PROFIT_MIN_AGE) GroupStatistics::VehicleReachedProfitAge(v);
 
		if (v->IsPrimaryVehicle()) {
 
			GroupStatistics::AddProfitLastYear(v);
 
			if (v->age > VEHICLE_PROFIT_MIN_AGE) GroupStatistics::VehicleReachedMinAge(v);
 
		}
 
	}
 
}
 

	
 
@@ -789,30 +807,30 @@ uint GetGroupNumVehicle(CompanyID compan
 
 * @param type The vehicle type of the group
 
 * @return The number of vehicles above profit minimum age in the group
 
 */
 
uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type)
 
uint GetGroupNumVehicleMinAge(CompanyID company, GroupID id_g, VehicleType type)
 
{
 
	uint count = 0;
 
	for (const Group *g : Group::Iterate()) {
 
		if (g->parent == id_g) count += GetGroupNumProfitVehicle(company, g->index, type);
 
		if (g->parent == id_g) count += GetGroupNumVehicleMinAge(company, g->index, type);
 
	}
 
	return count + GroupStatistics::Get(company, id_g, type).num_profit_vehicle;
 
	return count + GroupStatistics::Get(company, id_g, type).num_vehicle_min_age;
 
}
 

	
 
/**
 
 * Get last year's profit for the group with GroupID
 
 * id_g and its sub-groups.
 
 * Get last year's profit of vehicles above minimum age
 
 * for the group with GroupID id_g and its sub-groups.
 
 * @param company The company the group belongs to
 
 * @param id_g The GroupID of the group used
 
 * @param type The vehicle type of the group
 
 * @return Last year's profit for the group
 
 * @return Last year's profit of vehicles above minimum age for the group
 
 */
 
Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type)
 
Money GetGroupProfitLastYearMinAge(CompanyID company, GroupID id_g, VehicleType type)
 
{
 
	Money sum = 0;
 
	for (const Group *g : Group::Iterate()) {
 
		if (g->parent == id_g) sum += GetGroupProfitLastYear(company, g->index, type);
 
		if (g->parent == id_g) sum += GetGroupProfitLastYearMinAge(company, g->index, type);
 
	}
 
	return sum + GroupStatistics::Get(company, id_g, type).profit_last_year;
 
	return sum + GroupStatistics::Get(company, id_g, type).profit_last_year_min_age;
 
}
 

	
 
void RemoveAllGroupsForCompany(const CompanyID company)
src/group_gui.cpp
Show inline comments
 
@@ -302,13 +302,13 @@ private:
 
		/* draw the profit icon */
 
		x = rtl ? x - WidgetDimensions::scaled.hsep_normal - this->column_size[VGC_PROFIT].width : x + WidgetDimensions::scaled.hsep_normal + this->column_size[VGC_AUTOREPLACE].width;
 
		SpriteID spr;
 
		uint num_profit_vehicle = GetGroupNumProfitVehicle(this->vli.company, g_id, this->vli.vtype);
 
		Money profit_last_year = GetGroupProfitLastYear(this->vli.company, g_id, this->vli.vtype);
 
		if (num_profit_vehicle == 0) {
 
		uint num_vehicle_min_age = GetGroupNumVehicleMinAge(this->vli.company, g_id, this->vli.vtype);
 
		Money profit_last_year_min_age = GetGroupProfitLastYearMinAge(this->vli.company, g_id, this->vli.vtype);
 
		if (num_vehicle_min_age == 0) {
 
			spr = SPR_PROFIT_NA;
 
		} else if (profit_last_year < 0) {
 
		} else if (profit_last_year_min_age < 0) {
 
			spr = SPR_PROFIT_NEGATIVE;
 
		} else if (profit_last_year < VEHICLE_PROFIT_THRESHOLD * num_profit_vehicle) {
 
		} else if (profit_last_year_min_age < VEHICLE_PROFIT_THRESHOLD * num_vehicle_min_age) {
 
			spr = SPR_PROFIT_SOME;
 
		} else {
 
			spr = SPR_PROFIT_LOT;
src/vehicle.cpp
Show inline comments
 
@@ -1379,7 +1379,7 @@ void AgeVehicle(Vehicle *v)
 
{
 
	if (v->age < MAX_DAY) {
 
		v->age++;
 
		if (v->IsPrimaryVehicle() && v->age == VEHICLE_PROFIT_MIN_AGE + 1) GroupStatistics::VehicleReachedProfitAge(v);
 
		if (v->IsPrimaryVehicle() && v->age == VEHICLE_PROFIT_MIN_AGE + 1) GroupStatistics::VehicleReachedMinAge(v);
 
	}
 

	
 
	if (!v->IsPrimaryVehicle() && (v->type != VEH_TRAIN || !Train::From(v)->IsEngine())) return;
0 comments (0 inline, 0 general)