From f4ca94d3f6e1377cc25c24666d0f238e5b51d211 Mon Sep 17 00:00:00 2001 From: Tyler Trahan Date: Fri, 26 Nov 2021 12:11:16 -0700 Subject: [PATCH] Codechange: Revenue is not the same as Income Income is revenue minus costs. Let's name things correctly (without breaking the script API). --- src/aircraft.h | 2 +- src/company_cmd.cpp | 10 +++++----- src/economy.cpp | 2 +- src/economy_type.h | 10 +++++----- src/roadveh.h | 2 +- src/script/api/script_company.hpp | 28 ++++++++++++++-------------- src/ship.h | 2 +- src/train.h | 2 +- 8 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/aircraft.h b/src/aircraft.h index d201743a6f..0a5c0e5530 100644 --- a/src/aircraft.h +++ b/src/aircraft.h @@ -91,7 +91,7 @@ struct Aircraft FINAL : public SpecializedVehicle { void MarkDirty(); void UpdateDeltaXY(); - ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_INC : EXPENSES_AIRCRAFT_RUN; } + ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_REVENUE : EXPENSES_AIRCRAFT_RUN; } bool IsPrimaryVehicle() const { return this->IsNormalAircraft(); } void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const; int GetDisplaySpeed() const { return this->cur_speed; } diff --git a/src/company_cmd.cpp b/src/company_cmd.cpp index 99a2d5bd6c..136029f523 100644 --- a/src/company_cmd.cpp +++ b/src/company_cmd.cpp @@ -219,17 +219,17 @@ static void SubtractMoneyFromAnyCompany(Company *c, const CommandCost &cost) c->money -= cost.GetCost(); c->yearly_expenses[0][cost.GetExpensesType()] += cost.GetCost(); - if (HasBit(1 << EXPENSES_TRAIN_INC | - 1 << EXPENSES_ROADVEH_INC | - 1 << EXPENSES_AIRCRAFT_INC | - 1 << EXPENSES_SHIP_INC, cost.GetExpensesType())) { + if (HasBit(1 << EXPENSES_TRAIN_REVENUE | + 1 << EXPENSES_ROADVEH_REVENUE | + 1 << EXPENSES_AIRCRAFT_REVENUE | + 1 << EXPENSES_SHIP_REVENUE, cost.GetExpensesType())) { c->cur_economy.income -= cost.GetCost(); } else if (HasBit(1 << EXPENSES_TRAIN_RUN | 1 << EXPENSES_ROADVEH_RUN | 1 << EXPENSES_AIRCRAFT_RUN | 1 << EXPENSES_SHIP_RUN | 1 << EXPENSES_PROPERTY | - 1 << EXPENSES_LOAN_INT, cost.GetExpensesType())) { + 1 << EXPENSES_LOAN_INTEREST, cost.GetExpensesType())) { c->cur_economy.expenses -= cost.GetCost(); } diff --git a/src/economy.cpp b/src/economy.cpp index df668cbce7..fdccbd871b 100644 --- a/src/economy.cpp +++ b/src/economy.cpp @@ -831,7 +831,7 @@ static void CompaniesPayInterest() Money up_to_previous_month = yearly_fee * _cur_month / 12; Money up_to_this_month = yearly_fee * (_cur_month + 1) / 12; - SubtractMoneyFromCompany(CommandCost(EXPENSES_LOAN_INT, up_to_this_month - up_to_previous_month)); + SubtractMoneyFromCompany(CommandCost(EXPENSES_LOAN_INTEREST, up_to_this_month - up_to_previous_month)); SubtractMoneyFromCompany(CommandCost(EXPENSES_OTHER, _price[PR_STATION_VALUE] >> 2)); } diff --git a/src/economy_type.h b/src/economy_type.h index 1cb43b8ee9..8b4b0901e8 100644 --- a/src/economy_type.h +++ b/src/economy_type.h @@ -162,11 +162,11 @@ enum ExpensesType : byte { EXPENSES_AIRCRAFT_RUN, ///< Running costs aircraft. EXPENSES_SHIP_RUN, ///< Running costs ships. EXPENSES_PROPERTY, ///< Property costs. - EXPENSES_TRAIN_INC, ///< Income from trains. - EXPENSES_ROADVEH_INC, ///< Income from road vehicles. - EXPENSES_AIRCRAFT_INC, ///< Income from aircraft. - EXPENSES_SHIP_INC, ///< Income from ships. - EXPENSES_LOAN_INT, ///< Interest payments over the loan. + EXPENSES_TRAIN_REVENUE, ///< Revenue from trains. + EXPENSES_ROADVEH_REVENUE, ///< Revenue from road vehicles. + EXPENSES_AIRCRAFT_REVENUE, ///< Revenue from aircraft. + EXPENSES_SHIP_REVENUE, ///< Revenue from ships. + EXPENSES_LOAN_INTEREST, ///< Interest payments over the loan. EXPENSES_OTHER, ///< Other expenses. EXPENSES_END, ///< Number of expense types. INVALID_EXPENSES = 0xFF, ///< Invalid expense type. diff --git a/src/roadveh.h b/src/roadveh.h index 028af9decb..3ef17dfdac 100644 --- a/src/roadveh.h +++ b/src/roadveh.h @@ -126,7 +126,7 @@ struct RoadVehicle FINAL : public GroundVehicle { void MarkDirty(); void UpdateDeltaXY(); - ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_ROADVEH_INC : EXPENSES_ROADVEH_RUN; } + ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_ROADVEH_REVENUE : EXPENSES_ROADVEH_RUN; } bool IsPrimaryVehicle() const { return this->IsFrontEngine(); } void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const; int GetDisplaySpeed() const { return this->gcache.last_speed / 2; } diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp index 635b6fdee0..947698b171 100644 --- a/src/script/api/script_company.hpp +++ b/src/script/api/script_company.hpp @@ -100,20 +100,20 @@ public: * @api -ai */ enum ExpensesType : byte { - EXPENSES_CONSTRUCTION = ::EXPENSES_CONSTRUCTION, ///< Construction costs. - EXPENSES_NEW_VEHICLES = ::EXPENSES_NEW_VEHICLES, ///< New vehicles. - EXPENSES_TRAIN_RUN = ::EXPENSES_TRAIN_RUN, ///< Running costs trains. - EXPENSES_ROADVEH_RUN = ::EXPENSES_ROADVEH_RUN, ///< Running costs road vehicles. - EXPENSES_AIRCRAFT_RUN = ::EXPENSES_AIRCRAFT_RUN, ///< Running costs aircraft. - EXPENSES_SHIP_RUN = ::EXPENSES_SHIP_RUN, ///< Running costs ships. - EXPENSES_PROPERTY = ::EXPENSES_PROPERTY, ///< Property costs. - EXPENSES_TRAIN_INC = ::EXPENSES_TRAIN_INC, ///< Income from trains. - EXPENSES_ROADVEH_INC = ::EXPENSES_ROADVEH_INC, ///< Income from road vehicles. - EXPENSES_AIRCRAFT_INC = ::EXPENSES_AIRCRAFT_INC, ///< Income from aircraft. - EXPENSES_SHIP_INC = ::EXPENSES_SHIP_INC, ///< Income from ships. - EXPENSES_LOAN_INT = ::EXPENSES_LOAN_INT, ///< Interest payments over the loan. - EXPENSES_OTHER = ::EXPENSES_OTHER, ///< Other expenses. - EXPENSES_INVALID = ::INVALID_EXPENSES, ///< Invalid expense type. + EXPENSES_CONSTRUCTION = ::EXPENSES_CONSTRUCTION, ///< Construction costs. + EXPENSES_NEW_VEHICLES = ::EXPENSES_NEW_VEHICLES, ///< New vehicles. + EXPENSES_TRAIN_RUN = ::EXPENSES_TRAIN_RUN, ///< Running costs trains. + EXPENSES_ROADVEH_RUN = ::EXPENSES_ROADVEH_RUN, ///< Running costs road vehicles. + EXPENSES_AIRCRAFT_RUN = ::EXPENSES_AIRCRAFT_RUN, ///< Running costs aircraft. + EXPENSES_SHIP_RUN = ::EXPENSES_SHIP_RUN, ///< Running costs ships. + EXPENSES_PROPERTY = ::EXPENSES_PROPERTY, ///< Property costs. + EXPENSES_TRAIN_INC = ::EXPENSES_TRAIN_REVENUE, ///< Revenue from trains. + EXPENSES_ROADVEH_INC = ::EXPENSES_ROADVEH_REVENUE, ///< Revenue from road vehicles. + EXPENSES_AIRCRAFT_INC = ::EXPENSES_AIRCRAFT_REVENUE, ///< Revenue from aircraft. + EXPENSES_SHIP_INC = ::EXPENSES_SHIP_REVENUE, ///< Revenue from ships. + EXPENSES_LOAN_INT = ::EXPENSES_LOAN_INTEREST, ///< Interest payments over the loan. + EXPENSES_OTHER = ::EXPENSES_OTHER, ///< Other expenses. + EXPENSES_INVALID = ::INVALID_EXPENSES, ///< Invalid expense type. }; /** diff --git a/src/ship.h b/src/ship.h index b5578d1afb..66e29f4c3c 100644 --- a/src/ship.h +++ b/src/ship.h @@ -37,7 +37,7 @@ struct Ship FINAL : public SpecializedVehicle { void MarkDirty(); void UpdateDeltaXY(); - ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_SHIP_INC : EXPENSES_SHIP_RUN; } + ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_SHIP_REVENUE : EXPENSES_SHIP_RUN; } void PlayLeaveStationSound() const; bool IsPrimaryVehicle() const { return true; } void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const; diff --git a/src/train.h b/src/train.h index 0b7b7be5bf..c2d311878c 100644 --- a/src/train.h +++ b/src/train.h @@ -109,7 +109,7 @@ struct Train FINAL : public GroundVehicle { void MarkDirty(); void UpdateDeltaXY(); - ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_TRAIN_INC : EXPENSES_TRAIN_RUN; } + ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_TRAIN_REVENUE : EXPENSES_TRAIN_RUN; } void PlayLeaveStationSound() const; bool IsPrimaryVehicle() const { return this->IsFrontEngine(); } void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const;