1
0
mirror of https://github.com/OpenTTD/OpenTTD synced 2026-01-26 05:34:12 +01:00

Doc: Add docs for members of ScoreID enum.

This commit is contained in:
Cyprian Klimaszewski
2026-01-10 22:43:40 +01:00
committed by rubidium42
parent 46fd829267
commit 6afdf51aba

View File

@@ -59,20 +59,18 @@ struct Economy {
/** Score categories in the detailed performance rating. */
enum ScoreID : uint8_t {
SCORE_BEGIN = 0,
SCORE_VEHICLES = 0,
SCORE_STATIONS = 1,
SCORE_MIN_PROFIT = 2,
SCORE_MIN_INCOME = 3,
SCORE_MAX_INCOME = 4,
SCORE_DELIVERED = 5,
SCORE_CARGO = 6,
SCORE_MONEY = 7,
SCORE_LOAN = 8,
SCORE_TOTAL = 9, ///< This must always be the last entry
SCORE_END = 10, ///< How many scores are there..
SCORE_BEGIN = 0, ///< The lowest valid value.
SCORE_VEHICLES = 0, ///< Number of vehicles that turned profit last year.
SCORE_STATIONS = 1, ///< Number of recently-serviced stations.
SCORE_MIN_PROFIT = 2, ///< The profit of the vehicle with the lowest income.
SCORE_MIN_INCOME = 3, ///< Income in the quater with the lowest profit of the last 12 quaters.
SCORE_MAX_INCOME = 4, ///< Income in the quater with the highest profit of the last 12 quaters.
SCORE_DELIVERED = 5, ///< Units of cargo delivered in the last four quaters.
SCORE_CARGO = 6, ///< Number of types of cargo delivered in the last four quaters.
SCORE_MONEY = 7, ///< Amount of money company has in the bank.
SCORE_LOAN = 8, ///< The amount of money company can take as a loan.
SCORE_TOTAL = 9, ///< Total points out of possible points ,must always be the last entry.
SCORE_END = 10, ///< Score ID end marker.
};
DECLARE_INCREMENT_DECREMENT_OPERATORS(ScoreID)