You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
143 lines
4.0 KiB
C++
143 lines
4.0 KiB
C++
/* $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_info.hpp AIInfo keeps track of all information of an AI, like Author, Description, ... */
|
|
|
|
#ifndef AI_INFO
|
|
#define AI_INFO
|
|
|
|
#include <list>
|
|
#include "../core/smallmap_type.hpp"
|
|
#include "../script/script_info.hpp"
|
|
|
|
enum AIConfigFlags {
|
|
AICONFIG_NONE = 0x0,
|
|
AICONFIG_RANDOM = 0x1, //!< When randomizing the AI, pick any value between min_value and max_value when on custom difficulty setting.
|
|
AICONFIG_BOOLEAN = 0x2, //!< This value is a boolean (either 0 (false) or 1 (true) ).
|
|
};
|
|
|
|
typedef SmallMap<int, char *> LabelMapping;
|
|
|
|
struct AIConfigItem {
|
|
const char *name; //!< The name of the configuration setting.
|
|
const char *description; //!< The description of the configuration setting.
|
|
int min_value; //!< The minimal value this configuration setting can have.
|
|
int max_value; //!< The maximal value this configuration setting can have.
|
|
int custom_value; //!< The default value on custom difficulty setting.
|
|
int easy_value; //!< The default value on easy difficulty setting.
|
|
int medium_value; //!< The default value on medium difficulty setting.
|
|
int hard_value; //!< The default value on hard difficulty setting.
|
|
int random_deviation; //!< The maximum random deviation from the default value.
|
|
int step_size; //!< The step size in the gui.
|
|
AIConfigFlags flags; //!< Flags for the configuration setting.
|
|
LabelMapping *labels; //!< Text labels for the integer values.
|
|
};
|
|
|
|
extern AIConfigItem _start_date_config;
|
|
|
|
typedef std::list<AIConfigItem> AIConfigItemList;
|
|
|
|
class AIFileInfo : public ScriptFileInfo {
|
|
public:
|
|
/**
|
|
* Process the creation of a FileInfo object.
|
|
*/
|
|
static SQInteger Constructor(HSQUIRRELVM vm, AIFileInfo *info);
|
|
|
|
protected:
|
|
class AIScanner *base;
|
|
};
|
|
|
|
class AIInfo : public AIFileInfo {
|
|
public:
|
|
static const char *GetClassName() { return "AIInfo"; }
|
|
|
|
~AIInfo();
|
|
|
|
/**
|
|
* Create an AI, using this AIInfo as start-template.
|
|
*/
|
|
static SQInteger Constructor(HSQUIRRELVM vm);
|
|
static SQInteger DummyConstructor(HSQUIRRELVM vm);
|
|
|
|
/**
|
|
* Get the settings of the AI.
|
|
*/
|
|
bool GetSettings();
|
|
|
|
/**
|
|
* Get the config list for this AI.
|
|
*/
|
|
const AIConfigItemList *GetConfigList() const;
|
|
|
|
/**
|
|
* Get the description of a certain ai config option.
|
|
*/
|
|
const AIConfigItem *GetConfigItem(const char *name) const;
|
|
|
|
/**
|
|
* Check if we can start this AI.
|
|
*/
|
|
bool CanLoadFromVersion(int version) const;
|
|
|
|
/**
|
|
* Set a setting.
|
|
*/
|
|
SQInteger AddSetting(HSQUIRRELVM vm);
|
|
|
|
/**
|
|
* Add labels for a setting.
|
|
*/
|
|
SQInteger AddLabels(HSQUIRRELVM vm);
|
|
|
|
/**
|
|
* Get the default value for a setting.
|
|
*/
|
|
int GetSettingDefaultValue(const char *name) const;
|
|
|
|
/**
|
|
* Use this AI as a random AI.
|
|
*/
|
|
bool UseAsRandomAI() const { return this->use_as_random; }
|
|
|
|
/**
|
|
* Get the API version this AI is written for.
|
|
*/
|
|
const char *GetAPIVersion() const { return this->api_version; }
|
|
|
|
private:
|
|
AIConfigItemList config_list;
|
|
int min_loadable_version;
|
|
bool use_as_random;
|
|
const char *api_version;
|
|
};
|
|
|
|
class AILibrary : public AIFileInfo {
|
|
public:
|
|
AILibrary() : AIFileInfo(), category(NULL) {};
|
|
~AILibrary();
|
|
|
|
/**
|
|
* Create an AI, using this AIInfo as start-template.
|
|
*/
|
|
static SQInteger Constructor(HSQUIRRELVM vm);
|
|
|
|
static SQInteger Import(HSQUIRRELVM vm);
|
|
|
|
/**
|
|
* Get the category this library is in.
|
|
*/
|
|
const char *GetCategory() const { return this->category; }
|
|
|
|
private:
|
|
const char *category;
|
|
};
|
|
|
|
#endif /* AI_INFO */
|