script_info_docs.hpp

Go to the documentation of this file.
00001 /* $Id: script_info_docs.hpp 23613 2011-12-19 20:57:08Z truebrain $ */
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 /* This file exists purely for doxygen purposes. */
00013 
00027 class ScriptInfo {
00028 public:
00035   string GetAuthor();
00036 
00047   string GetName();
00048 
00063   string GetShortName();
00064 
00071   string GetDescription();
00072 
00086   int GetVersion();
00087 
00100   int MinVersionToLoad();
00101 
00111   string GetDate();
00112 
00130   bool UseAsRandomAI();
00131 
00143   bool IsDeveloperOnly();
00144 
00152   string CreateInstance();
00153 
00174   string GetAPIVersion();
00175 
00188   string GetURL();
00189 
00198   void GetSettings();
00199 
00201   enum ScriptConfigFlags {
00202     CONFIG_NONE,      
00203     CONFIG_RANDOM,    
00204     CONFIG_BOOLEAN,   
00205     CONFIG_INGAME,    
00206     CONFIG_DEVELOPER, 
00207   };
00208 
00240   void AddSetting(table setting_description);
00241 
00258   void AddLabels(const char *setting_name, table value_names);
00259 };