Function CmdDecreaseLoan

src/misc_cmd.cpp:85–117

* Decrease the loan of your company. * @param flags operation to perform * @param cmd when LoanCommand::Interval: pays back LOAN_INTERVAL, * when LoanCommand::Max: pays back the maximum loan permitting money (press CTRL), * when LoanCommand::Amount: pays back the amount specified in \c amount * @param amount amount to decrease the loan with, multitude of LOAN_INTERVAL. O

 * @return the cost of this operation or an error
 */
CommandCost CmdDecreaseLoan(DoCommandFlags flags, LoanCommand cmd, Money amount)
{
	Company *c = Company::Get(_current_company);

	if (c->current_loan == 0) return CommandCost(STR_ERROR_LOAN_ALREADY_REPAID);

	Money loan;
	switch (cmd) {
		default: return CMD_ERROR; // Invalid method
		case LoanCommand::Interval: // Pay back one step
			loan = std::min(c->current_loan, (Money)LOAN_INTERVAL);
			break;
		case LoanCommand::Max: // Pay back as much as possible
			loan = std::max(std::min(c->current_loan, GetAvailableMoneyForCommand()), (Money)LOAN_INTERVAL);
			loan -= loan % LOAN_INTERVAL;
			break;
		case LoanCommand::Amount: // Repay the given amount of loan
			loan = amount;
			if (loan % LOAN_INTERVAL != 0 || loan < LOAN_INTERVAL || loan > c->current_loan) return CMD_ERROR; // Invalid amount to loan
			break;
	}

	if (GetAvailableMoneyForCommand() < loan) {
		return CommandCostWithParam(STR_ERROR_CURRENCY_REQUIRED, loan);
	}

	if (flags.Test(DoCommandFlag::Execute)) {
		c->money        -= loan;
		c->current_loan -= loan;
		InvalidateCompanyWindows(c);
	}
	return CommandCost();
}

/**
 * Sets the max loan amount of your company. Does not respect the global loan setting.