OpenTTD-patches/src/economy_base.h

65 lines
2.3 KiB
C

/* $Id$ */
/*
* 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 economy_base.h Base classes related to the economy. */
#ifndef ECONOMY_BASE_H
#define ECONOMY_BASE_H
#include "cargopacket.h"
#include "company_type.h"
/** Type of pool to store cargo payments in; little over 1 million. */
typedef Pool<CargoPayment, CargoPaymentID, 512, 0xFF000> CargoPaymentPool;
/** The actual pool to store cargo payments in. */
extern CargoPaymentPool _cargo_payment_pool;
/**
* Helper class to perform the cargo payment.
*/
struct CargoPayment : CargoPaymentPool::PoolItem<&_cargo_payment_pool> {
Vehicle *front; ///< The front vehicle to do the payment of
Money route_profit; ///< The amount of money to add/remove from the bank account
Money visual_profit; ///< The visual profit to show
/* Unsaved variables */
Company *owner; ///< The owner of the vehicle
StationID current_station; ///< The current station
CargoID ct; ///< The currently handled cargo type
/** Constructor for pool saveload */
CargoPayment() {}
CargoPayment(Vehicle *front);
~CargoPayment();
Money PayTransfer(const CargoPacket *cp, uint count);
void PayFinalDelivery(const CargoPacket *cp, uint count);
/**
* Sets the currently handled cargo type.
* @param ct the cargo type to handle from now on.
*/
void SetCargo(CargoID ct) { this->ct = ct; }
};
/**
* Iterate over all cargo payments from a given start position.
* @param var The variable used for iterating.
* @param start The start of the iteration.
*/
#define FOR_ALL_CARGO_PAYMENTS_FROM(var, start) FOR_ALL_ITEMS_FROM(CargoPayment, cargo_payment_index, var, start)
/**
* Iterate over all cargo payments.
* @param var The variable used for iterating.
*/
#define FOR_ALL_CARGO_PAYMENTS(var) FOR_ALL_CARGO_PAYMENTS_FROM(var, 0)
#endif /* ECONOMY_BASE_H */