ai_subsidy.hpp

Go to the documentation of this file.
00001 /* $Id: ai_subsidy.hpp 17248 2009-08-21 20:21:05Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef AI_SUBSIDY_HPP
00013 #define AI_SUBSIDY_HPP
00014 
00015 #include "ai_object.hpp"
00016 #include "ai_company.hpp"
00017 
00021 class AISubsidy : public AIObject {
00022 public:
00023   static const char *GetClassName() { return "AISubsidy"; }
00024 
00029   enum SubsidyParticipantType {
00030     SPT_INDUSTRY =    0, 
00031     SPT_TOWN     =    1, 
00032     SPT_INVALID  = 0xFF, 
00033   };
00034 
00040   static bool IsValidSubsidy(SubsidyID subsidy_id);
00041 
00048   static bool IsAwarded(SubsidyID subsidy_id);
00049 
00056   static AICompany::CompanyID GetAwardedTo(SubsidyID subsidy_id);
00057 
00068   static int32 GetExpireDate(SubsidyID subsidy_id);
00069 
00077   static CargoID GetCargoType(SubsidyID subsidy_id);
00078 
00085   static SubsidyParticipantType GetSourceType(SubsidyID subsidy_id);
00086 
00095   static int32 GetSourceIndex(SubsidyID subsidy_id);
00096 
00103   static SubsidyParticipantType GetDestinationType(SubsidyID subsidy_id);
00104 
00113   static int32 GetDestinationIndex(SubsidyID subsidy_id);
00114 };
00115 
00116 #endif /* AI_SUBSIDY_HPP */

Generated on Sat Jun 5 21:52:02 2010 for OpenTTD by  doxygen 1.6.1