blob: 96ad92c31c50c209e38ec62161519c321e9cb3d0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/* $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 */
|
