Files @ r28060:53690f1ef210
Branch filter:

Location: cpp/openttd-patchpack/source/src/group.h - annotation

frosch
Feature: Base graphics can offer parameters for additional settings.
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r17675:70155598b958
r6643:fa000ce7441e
r6643:fa000ce7441e
r6643:fa000ce7441e
r6643:fa000ce7441e
r8770:06d779b8eed1
r11969:3526c3cc75dc
r10208:ef8fcc3dc4ca
r8254:b96be9ebfc6e
r8786:f24a6d1fba34
r23241:d2e564fdfd80
r6643:fa000ce7441e
r11967:df0600d2c7e7
r17675:70155598b958
r7382:750cdd87ddef
r18141:0f3c67cfc488
r18141:0f3c67cfc488
r26791:8e217aa7f11b
r26791:8e217aa7f11b
r27737:728d55b97775
r27737:728d55b97775
r27737:728d55b97775
r18150:7beac77bd864
r18150:7beac77bd864
r18150:7beac77bd864
r18141:0f3c67cfc488
r18141:0f3c67cfc488
r18141:0f3c67cfc488
r18141:0f3c67cfc488
r18142:429bd06a51e9
r18149:d084e89bff7d
r18149:d084e89bff7d
r18149:d084e89bff7d
r26791:8e217aa7f11b
r26791:8e217aa7f11b
r26791:8e217aa7f11b
r18149:d084e89bff7d
r18149:d084e89bff7d
r18150:7beac77bd864
r18150:7beac77bd864
r18150:7beac77bd864
r18150:7beac77bd864
r18150:7beac77bd864
r18150:7beac77bd864
r18143:604ab298ba0c
r18143:604ab298ba0c
r18146:ad1a95532d6a
r18143:604ab298ba0c
r18143:604ab298ba0c
r18144:d858ebd27b4b
r26791:8e217aa7f11b
r26791:8e217aa7f11b
r18143:604ab298ba0c
r18149:d084e89bff7d
r18142:429bd06a51e9
r18150:7beac77bd864
r18141:0f3c67cfc488
r18141:0f3c67cfc488
r27737:728d55b97775
r25226:099b6b8941ab
r25226:099b6b8941ab
r25225:126e4a36a4eb
r25224:92a124f03ad6
r25224:92a124f03ad6
r17675:70155598b958
r11967:df0600d2c7e7
r24214:a65c412aafcc
r23674:a5bafa1a02c5
r23661:3655a2df3316
r6643:fa000ce7441e
r27737:728d55b97775
r23661:3655a2df3316
r23661:3655a2df3316
r7382:750cdd87ddef
r23661:3655a2df3316
r23549:b0b438170a84
r23661:3655a2df3316
r21353:433db3a92931
r10207:a1fc2f2a33db
r6643:fa000ce7441e
r6643:fa000ce7441e
r6643:fa000ce7441e
r6643:fa000ce7441e
r6643:fa000ce7441e
r7258:6dd7a1782071
r7258:6dd7a1782071
r7258:6dd7a1782071
r7258:6dd7a1782071
r10207:a1fc2f2a33db
r7258:6dd7a1782071
r7258:6dd7a1782071
r7258:6dd7a1782071
r7258:6dd7a1782071
r7258:6dd7a1782071
r7258:6dd7a1782071
r6643:fa000ce7441e
r6643:fa000ce7441e
r6643:fa000ce7441e
r10207:a1fc2f2a33db
r23548:3cdac86631ad
r26791:8e217aa7f11b
r26791:8e217aa7f11b
r7258:6dd7a1782071
r12290:442d5d533a57
r12290:442d5d533a57
r6643:fa000ce7441e
r10207:a1fc2f2a33db
r21353:433db3a92931
r6643:fa000ce7441e
r6643:fa000ce7441e
/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */

/** @file group.h Base class for groups and group functions. */

#ifndef GROUP_H
#define GROUP_H

#include "group_type.h"
#include "core/pool_type.hpp"
#include "company_type.h"
#include "vehicle_type.h"
#include "engine_type.h"
#include "livery.h"

typedef Pool<Group, GroupID, 16, 64000> GroupPool;
extern GroupPool _group_pool; ///< Pool of groups.

/** Statistics and caches on the vehicles in a group. */
struct GroupStatistics {
	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_t *num_engines;                    ///< Caches the number of engines of each type the company owns.
	uint16_t num_vehicle;                     ///< Number of vehicles.
	uint16_t 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?

	GroupStatistics();
	~GroupStatistics();

	void Clear();

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

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

	void ClearAutoreplace()
	{
		this->autoreplace_defined = false;
		this->autoreplace_finished = false;
	}

	static GroupStatistics &Get(CompanyID company, GroupID id_g, VehicleType type);
	static GroupStatistics &Get(const Vehicle *v);
	static GroupStatistics &GetAllGroup(const Vehicle *v);

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

	static void UpdateProfits();
	static void UpdateAfterLoad();
	static void UpdateAutoreplace(CompanyID company);
};

enum GroupFlags : uint8_t {
	GF_REPLACE_PROTECTION,    ///< If set to true, the global autoreplace has no effect on the group
	GF_REPLACE_WAGON_REMOVAL, ///< If set, autoreplace will perform wagon removal on vehicles in this group.
	GF_END,
};

/** Group data. */
struct Group : GroupPool::PoolItem<&_group_pool> {
	std::string name;           ///< Group Name
	Owner owner;                ///< Group Owner
	VehicleType vehicle_type;   ///< Vehicle type of the group

	uint8_t flags;                ///< Group flags
	Livery livery;              ///< Custom colour scheme for vehicles in this group
	GroupStatistics statistics; ///< NOSAVE: Statistics and caches on the vehicles in the group.

	bool folded;                ///< NOSAVE: Is this group folded in the group view?

	GroupID parent;             ///< Parent group

	Group(CompanyID owner = INVALID_COMPANY);
};


static inline bool IsDefaultGroupID(GroupID index)
{
	return index == DEFAULT_GROUP;
}

/**
 * Checks if a GroupID stands for all vehicles of a company
 * @param id_g The GroupID to check
 * @return true is id_g is identical to ALL_GROUP
 */
static inline bool IsAllGroupID(GroupID id_g)
{
	return id_g == ALL_GROUP;
}


uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e);
uint GetGroupNumVehicle(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);
void RemoveVehicleFromGroup(const Vehicle *v);
void RemoveAllGroupsForCompany(const CompanyID company);
bool GroupIsInGroup(GroupID search, GroupID group);

#endif /* GROUP_H */