diff options
author | truebrain <truebrain@openttd.org> | 2011-11-29 23:07:38 +0000 |
---|---|---|
committer | truebrain <truebrain@openttd.org> | 2011-11-29 23:07:38 +0000 |
commit | afdb67a3534f85b4efbd3327ece8137211042d7b (patch) | |
tree | b62375a3846c2089e1c6904331e8f5a3d44851ba /src/ai/api/ai_industrytype.hpp | |
parent | 5f6dc2466318b1275e8b654a260a6c565a0ecc5c (diff) | |
download | openttd-afdb67a3534f85b4efbd3327ece8137211042d7b.tar.xz |
(svn r23354) -Codechange: move all src/ai/api/ai_*.[hc]pp files to src/script/api/script_* (Rubidium)
Diffstat (limited to 'src/ai/api/ai_industrytype.hpp')
-rw-r--r-- | src/ai/api/ai_industrytype.hpp | 153 |
1 files changed, 0 insertions, 153 deletions
diff --git a/src/ai/api/ai_industrytype.hpp b/src/ai/api/ai_industrytype.hpp deleted file mode 100644 index 523fad8e3..000000000 --- a/src/ai/api/ai_industrytype.hpp +++ /dev/null @@ -1,153 +0,0 @@ -/* $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 ai_industrytype.hpp Everything to query and build industries. */ - -#ifndef AI_INDUSTRYTYPE_HPP -#define AI_INDUSTRYTYPE_HPP - -#include "ai_list.hpp" - -/** - * Class that handles all industry-type related functions. - */ -class AIIndustryType : public AIObject { -public: - /** - * Special IndustryTypes. - */ - enum SpecialIndustryType { - INDUSTRYTYPE_UNKNOWN = 0xFE, ///< Unknown/unspecific industrytype. (Usable for AIRail::BuildNewGRFRailStation()) - INDUSTRYTYPE_TOWN = 0xFF, ///< No industry, but town. (Usable for AIRail::BuildNewGRFRailStation()) - }; - - /** - * Checks whether the given industry-type is valid. - * @param industry_type The type check. - * @return True if and only if the industry-type is valid. - */ - static bool IsValidIndustryType(IndustryType industry_type); - - /** - * Get the name of an industry-type. - * @param industry_type The type to get the name for. - * @pre IsValidIndustryType(industry_type). - * @return The name of an industry. - */ - static char *GetName(IndustryType industry_type); - - /** - * Get a list of CargoID possible produced by this industry-type. - * @warning This function only returns the default cargos of the industry type. - * Industries can specify new cargotypes on construction. - * @param industry_type The type to get the CargoIDs for. - * @pre IsValidIndustryType(industry_type). - * @return The CargoIDs of all cargotypes this industry could produce. - */ - static AIList *GetProducedCargo(IndustryType industry_type); - - /** - * Get a list of CargoID accepted by this industry-type. - * @warning This function only returns the default cargos of the industry type. - * Industries can specify new cargotypes on construction. - * @param industry_type The type to get the CargoIDs for. - * @pre IsValidIndustryType(industry_type). - * @return The CargoIDs of all cargotypes this industry accepts. - */ - static AIList *GetAcceptedCargo(IndustryType industry_type); - - /** - * Is this industry type a raw industry? - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True if it should be handled as a raw industry. - */ - static bool IsRawIndustry(IndustryType industry_type); - - /** - * Can the production of this industry increase? - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True if the production of this industry can increase. - */ - static bool ProductionCanIncrease(IndustryType industry_type); - - /** - * Get the cost for building this industry-type. - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return The cost for building this industry-type. - */ - static Money GetConstructionCost(IndustryType industry_type); - - /** - * Can you build this type of industry? - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True if you can build this type of industry at locations of your choice. - * @note Returns false if you can only prospect this type of industry, or not build it at all. - */ - static bool CanBuildIndustry(IndustryType industry_type); - - /** - * Can you prospect this type of industry? - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True if you can prospect this type of industry. - * @note If the setting "Manual primary industry construction method" is set - * to either "None" or "as other industries" this function always returns false. - */ - static bool CanProspectIndustry(IndustryType industry_type); - - /** - * Build an industry of the specified type. - * @param industry_type The type of the industry to build. - * @param tile The tile to build the industry on. - * @pre CanBuildIndustry(industry_type). - * @return True if the industry was successfully build. - */ - static bool BuildIndustry(IndustryType industry_type, TileIndex tile); - - /** - * Prospect an industry of this type. Prospecting an industries let the game try to create - * an industry on a random place on the map. - * @param industry_type The type of the industry. - * @pre CanProspectIndustry(industry_type). - * @return True if no error occurred while trying to prospect. - * @note Even if true is returned there is no guarantee a new industry is build. - * @note If true is returned the money is paid, whether a new industry was build or not. - */ - static bool ProspectIndustry(IndustryType industry_type); - - /** - * Is this type of industry built on water. - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True when this type is built on water. - */ - static bool IsBuiltOnWater(IndustryType industry_type); - - /** - * Does this type of industry have a heliport? - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True when this type has a heliport. - */ - static bool HasHeliport(IndustryType industry_type); - - /** - * Does this type of industry have a dock? - * @param industry_type The type of the industry. - * @pre IsValidIndustryType(industry_type). - * @return True when this type has a dock. - */ - static bool HasDock(IndustryType industry_type); -}; - -#endif /* AI_INDUSTRYTYPE_HPP */ |