/***************************************************************************** * Copyright (c) 2014-2019 OpenRCT2 developers * * For a complete list of all authors, please refer to contributors.md * Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2 * * OpenRCT2 is licensed under the GNU General Public License version 3. *****************************************************************************/ #include "Finance.h" #include "../Context.h" #include "../Game.h" #include "../OpenRCT2.h" #include "../interface/Window.h" #include "../localisation/Date.h" #include "../localisation/Localisation.h" #include "../peep/Peep.h" #include "../peep/Staff.h" #include "../ride/Ride.h" #include "../scenario/Scenario.h" #include "../util/Util.h" #include "../windows/Intent.h" #include "../world/Park.h" #include "../world/Sprite.h" /** * Monthly staff wages * * rct2: 0x00992A00 */ const money32 wage_table[STAFF_TYPE_COUNT] = { MONEY(50, 00), // Handyman MONEY(80, 00), // Mechanic MONEY(60, 00), // Security guard MONEY(55, 00), // Entertainer }; // Monthly research funding costs const money32 research_cost_table[RESEARCH_FUNDING_COUNT] = { MONEY(0, 00), // No funding MONEY(100, 00), // Minimum funding MONEY(200, 00), // Normal funding MONEY(400, 00), // Maximum funding }; static constexpr const int32_t dword_988E60[RCT_EXPENDITURE_TYPE_COUNT] = { 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 0, }; money32 gInitialCash; money32 gCash; money32 gBankLoan; uint8_t gBankLoanInterestRate; money32 gMaxBankLoan; money32 gCurrentExpenditure; money32 gCurrentProfit; money32 gHistoricalProfit; money32 gWeeklyProfitAverageDividend; uint16_t gWeeklyProfitAverageDivisor; money32 gCashHistory[FINANCE_GRAPH_SIZE]; money32 gWeeklyProfitHistory[FINANCE_GRAPH_SIZE]; money32 gParkValueHistory[FINANCE_GRAPH_SIZE]; money32 gExpenditureTable[EXPENDITURE_TABLE_MONTH_COUNT][RCT_EXPENDITURE_TYPE_COUNT]; uint8_t gCommandExpenditureType; /** * Checks the condition if the game is required to use money. * @param flags game command flags. */ bool finance_check_money_required(uint32_t flags) { if (gParkFlags & PARK_FLAGS_NO_MONEY) return false; if (gScreenFlags & SCREEN_FLAGS_EDITOR) return false; if (flags & GAME_COMMAND_FLAG_NO_SPEND) return false; if (flags & GAME_COMMAND_FLAG_GHOST) return false; return true; } /** * Checks if enough money is available. * @param cost. * @param flags game command flags. */ bool finance_check_affordability(money32 cost, uint32_t flags) { return cost <= 0 || !finance_check_money_required(flags) || cost <= gCash; } /** * Pay an amount of money. * rct2: 0x069C674 * @param amount (eax) * @param type passed via global var 0x0141F56C (RCT2_ADDRESS_NEXT_EXPENDITURE_TYPE), our type is that var/4. */ void finance_payment(money32 amount, rct_expenditure_type type) { // overflow check gCash = add_clamp_money32(gCash, -amount); gExpenditureTable[0][type] -= amount; if (dword_988E60[type] & 1) { // Cumulative amount of money spent this day gCurrentExpenditure -= amount; } auto intent = Intent(INTENT_ACTION_UPDATE_CASH); context_broadcast_intent(&intent); } /** * Pays the wages of all active staff members in the park. * rct2: 0x006C18A9 */ void finance_pay_wages() { Peep* peep; uint16_t spriteIndex; if (gParkFlags & PARK_FLAGS_NO_MONEY) { return; } FOR_ALL_STAFF (spriteIndex, peep) { finance_payment(wage_table[peep->staff_type] / 4, RCT_EXPENDITURE_TYPE_WAGES); } } /** * Pays the current research level's cost. * rct2: 0x00684DA5 **/ void finance_pay_research() { uint8_t level; if (gParkFlags & PARK_FLAGS_NO_MONEY) { return; } level = gResearchFundingLevel; finance_payment(research_cost_table[level] / 4, RCT_EXPENDITURE_TYPE_RESEARCH); } /** * Pay interest on current loans. * rct2: 0x0069E092 */ void finance_pay_interest() { // This variable uses the 64-bit type as the computation below can involve multiplying very large numbers // that will overflow money32 if the loan is greater than (1 << 31) / (5 * current_interest_rate) money64 current_loan = gBankLoan; uint8_t current_interest_rate = gBankLoanInterestRate; money32 interest_to_pay; if (gParkFlags & PARK_FLAGS_NO_MONEY) { return; } interest_to_pay = (current_loan * 5 * current_interest_rate) >> 14; finance_payment(interest_to_pay, RCT_EXPENDITURE_TYPE_INTEREST); } /** * * rct2: 0x006AC885 */ void finance_pay_ride_upkeep() { int32_t i; Ride* ride; FOR_ALL_RIDES (i, ride) { if (!(ride->lifecycle_flags & RIDE_LIFECYCLE_EVER_BEEN_OPENED)) { ride->Renew(); } if (ride->status != RIDE_STATUS_CLOSED && !(gParkFlags & PARK_FLAGS_NO_MONEY)) { int16_t upkeep = ride->upkeep_cost; if (upkeep != -1) { ride->total_profit -= upkeep; ride->window_invalidate_flags |= RIDE_INVALIDATE_RIDE_INCOME; finance_payment(upkeep, RCT_EXPENDITURE_TYPE_RIDE_RUNNING_COSTS); } } if (ride->last_crash_type != RIDE_CRASH_TYPE_NONE) { ride->last_crash_type--; } } } void finance_reset_history() { for (int32_t i = 0; i < FINANCE_GRAPH_SIZE; i++) { gCashHistory[i] = MONEY32_UNDEFINED; gWeeklyProfitHistory[i] = MONEY32_UNDEFINED; gParkValueHistory[i] = MONEY32_UNDEFINED; } } /** * * rct2: 0x0069DEFB */ void finance_init() { // It only initialises the first month for (uint32_t i = 0; i < RCT_EXPENDITURE_TYPE_COUNT; i++) { gExpenditureTable[0][i] = 0; } gCurrentExpenditure = 0; gCurrentProfit = 0; gWeeklyProfitAverageDividend = 0; gWeeklyProfitAverageDivisor = 0; gInitialCash = MONEY(10000, 00); // Cheat detection gCash = MONEY(10000, 00); gBankLoan = MONEY(10000, 00); gMaxBankLoan = MONEY(20000, 00); gHistoricalProfit = 0; gBankLoanInterestRate = 10; gParkValue = 0; gCompanyValue = 0; gScenarioCompletedCompanyValue = MONEY32_UNDEFINED; gTotalAdmissions = 0; gTotalIncomeFromAdmissions = 0; gScenarioCompletedBy = "?"; } /** * * rct2: 0x0069E79A */ void finance_update_daily_profit() { gCurrentProfit = 7 * gCurrentExpenditure; gCurrentExpenditure = 0; // Reset daily expenditure money32 current_profit = 0; if (!(gParkFlags & PARK_FLAGS_NO_MONEY)) { // Staff costs uint16_t sprite_index; Peep* peep; FOR_ALL_STAFF (sprite_index, peep) { current_profit -= wage_table[peep->staff_type]; } // Research costs uint8_t level = gResearchFundingLevel; current_profit -= research_cost_table[level]; // Loan costs money32 current_loan = gBankLoan; current_profit -= current_loan / 600; // Ride costs Ride* ride; int32_t i; FOR_ALL_RIDES (i, ride) { if (ride->status != RIDE_STATUS_CLOSED && ride->upkeep_cost != MONEY16_UNDEFINED) { current_profit -= 2 * ride->upkeep_cost; } } } // This is not equivalent to / 4 due to rounding of negative numbers current_profit = current_profit >> 2; gCurrentProfit += current_profit; // These are related to weekly profit graph gWeeklyProfitAverageDividend += gCurrentProfit; gWeeklyProfitAverageDivisor += 1; window_invalidate_by_class(WC_FINANCES); } money32 finance_get_initial_cash() { return gInitialCash; } money32 finance_get_current_loan() { return gBankLoan; } money32 finance_get_maximum_loan() { return gMaxBankLoan; } money32 finance_get_current_cash() { return gCash; } /** * Shift the expenditure table history one month to the left * If the table is full, accumulate the sum of the oldest month first * rct2: 0x0069DEAD */ void finance_shift_expenditure_table() { // If EXPENDITURE_TABLE_MONTH_COUNT months have passed then is full, sum the oldest month if (gDateMonthsElapsed >= EXPENDITURE_TABLE_MONTH_COUNT) { money32 sum = 0; for (uint32_t i = 0; i < RCT_EXPENDITURE_TYPE_COUNT; i++) { sum += gExpenditureTable[EXPENDITURE_TABLE_MONTH_COUNT - 1][i]; } gHistoricalProfit += sum; } // Shift the table for (size_t i = EXPENDITURE_TABLE_MONTH_COUNT - 1; i >= 1; i--) { for (size_t j = 0; j < RCT_EXPENDITURE_TYPE_COUNT; j++) { gExpenditureTable[i][j] = gExpenditureTable[i - 1][j]; } } // Zero the beginning of the table, which is the new month for (uint32_t i = 0; i < RCT_EXPENDITURE_TYPE_COUNT; i++) { gExpenditureTable[0][i] = 0; } window_invalidate_by_class(WC_FINANCES); } /** * * rct2: 0x0069E89B */ void finance_reset_cash_to_initial() { gCash = gInitialCash; } /** * Gets the last month's profit from food, drink and merchandise. */ money32 finance_get_last_month_shop_profit() { money32 profit = 0; if (gDateMonthsElapsed != 0) { money32* lastMonthExpenditure = gExpenditureTable[1]; profit += lastMonthExpenditure[RCT_EXPENDITURE_TYPE_SHOP_SHOP_SALES]; profit += lastMonthExpenditure[RCT_EXPENDITURE_TYPE_SHOP_STOCK]; profit += lastMonthExpenditure[RCT_EXPENDITURE_TYPE_FOODDRINK_SALES]; profit += lastMonthExpenditure[RCT_EXPENDITURE_TYPE_FOODDRINK_STOCK]; } return profit; }