2a430d981f
-Change [FS#1134]: subsidies aren't bound to stations after awarding anymore, they still apply to town or industry, no matter what station is used for loading and unloading. Awarded subsidies from older savegames are lost -Change [NoAI]: due to these changes, AISubsidy::GetSource and AISubsidy::GetDestination now return STATION_INVALID for awarded subsidies
102 lines
3.4 KiB
C++
102 lines
3.4 KiB
C++
/* $Id$ */
|
|
|
|
/** @file ai_subsidy.hpp Everything to query subsidies. */
|
|
|
|
#ifndef AI_SUBSIDY_HPP
|
|
#define AI_SUBSIDY_HPP
|
|
|
|
#include "ai_object.hpp"
|
|
#include "ai_company.hpp"
|
|
|
|
/**
|
|
* Class that handles all subsidy related functions.
|
|
*/
|
|
class AISubsidy : public AIObject {
|
|
public:
|
|
static const char *GetClassName() { return "AISubsidy"; }
|
|
|
|
/**
|
|
* Check whether this is a valid SubsidyID.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @return True if and only if this subsidy is still valid.
|
|
*/
|
|
static bool IsValidSubsidy(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Checks whether this subsidy is already awarded to some company.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy).
|
|
* @return True if and only if this subsidy is already awarded.
|
|
*/
|
|
static bool IsAwarded(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Get the company index of the company this subsidy is awarded to.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsAwarded(subsidy_id).
|
|
* @return The companyindex of the company this subsidy is awarded to.
|
|
*/
|
|
static AICompany::CompanyID GetAwardedTo(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Get the date this subsidy expires. In case the subsidy is already
|
|
* awarded, return the date the subsidy expires, else, return the date the
|
|
* offer expires.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy_id).
|
|
* @return The last valid date of this subsidy.
|
|
* @note The return value of this function will change if the subsidy is
|
|
* awarded.
|
|
*/
|
|
static int32 GetExpireDate(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Get the cargo type that has to be transported in order to be awarded this
|
|
* subsidy.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy_id).
|
|
* @return The cargo type to transport.
|
|
*/
|
|
static CargoID GetCargoType(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Is the source of the subsidy a town or an industry.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy_id) && !IsAwarded(subsidy_id).
|
|
* @return True if the source is a town, false if it is an industry.
|
|
*/
|
|
static bool SourceIsTown(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Return the source TownID/IndustryID/StationID the subsidy is for.
|
|
* \li IsAwarded(subsidy_id) -> return INVALID_STATION.
|
|
* \li !IsAwarded(subsidy_id) && SourceIsTown(subsidy_id) -> return the TownID.
|
|
* \li !IsAwarded(subsidy_id) && !SourceIsTown(subsidy_id) -> return the IndustryID.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy_id).
|
|
* @return One of TownID/IndustryID/INVALID_STATION.
|
|
*/
|
|
static int32 GetSource(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Is the destination of the subsidy a town or an industry.
|
|
* @param subsidy_id The SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy_id) && !IsAwarded(subsidy_id).
|
|
* @return True if the destination is a town, false if it is an industry.
|
|
*/
|
|
static bool DestinationIsTown(SubsidyID subsidy_id);
|
|
|
|
/**
|
|
* Return the destination TownID/IndustryID/StationID the subsidy is for.
|
|
* \li IsAwarded(subsidy_id) -> return INVALID_STATION.
|
|
* \li !IsAwarded(subsidy_id) && DestinationIsTown(subsidy_id) -> return the TownID.
|
|
* \li !IsAwarded(subsidy_id) && !DestinationIsTown(subsidy_id) -> return the IndustryID.
|
|
* @param subsidy_id the SubsidyID to check.
|
|
* @pre IsValidSubsidy(subsidy_id).
|
|
* @return One of TownID/IndustryID/INVALID_STATION.
|
|
*/
|
|
static int32 GetDestination(SubsidyID subsidy_id);
|
|
};
|
|
|
|
#endif /* AI_SUBSIDY_HPP */
|