summaryrefslogtreecommitdiff
path: root/src/ai/ai_info.hpp
blob: 205e89b38bd8fc27382c66f1b282c474d96da084 (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/* $Id$ */

/** @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 "api/ai_object.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) ).
};

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.
	AIConfigFlags flags;     //!< Flags for the configuration setting.
};

typedef std::list<AIConfigItem> AIConfigItemList;

class AIFileInfo : public AIObject {
public:
	friend class AIInfo;
	friend class AILibrary;

	AIFileInfo() : author(NULL), name(NULL), description(NULL), date(NULL), instance_name(NULL) {};
	~AIFileInfo();

	/**
	 * Get the Author of the AI.
	 */
	const char *GetAuthor();

	/**
	 * Get the Name of the AI.
	 */
	const char *GetName();

	/**
	 * Get the description of the AI.
	 */
	const char *GetDescription();

	/**
	 * Get the version of the AI.
	 */
	int GetVersion();

	/**
	 * Get the settings of the AI.
	 */
	void GetSettings();

	/**
	 * Get the date of the AI.
	 */
	const char *GetDate();

	/**
	 * Get the name of the instance of the AI to create.
	 */
	const char *GetInstanceName();

	/**
	 * Check if we can start this AI.
	 */
	bool CanLoadFromVersion(int version);

	/**
	 * Get the name of the dir this AI is in.
	 */
	const char *GetDirName();

	/**
	 * Get the complete script name of this AI.
	 */
	const char *GetScriptName();

	/**
	 * Check if a given method exists.
	 */
	void CheckMethods(SQInteger *res, const char *name);

	/**
	 * Process the creation of a FileInfo object.
	 */
	static SQInteger Constructor(HSQUIRRELVM vm, AIFileInfo *info);

private:
	class Squirrel *engine;
	HSQOBJECT *SQ_instance;
	char *script_name;
	char *dir_name;
	class AIScanner *base;
	const char *author;
	const char *name;
	const char *description;
	const char *date;
	const char *instance_name;
};

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 config list for this AI.
	 */
	const AIConfigItemList *GetConfigList();

	/**
	 * Set a setting.
	 */
	SQInteger AddSetting(HSQUIRRELVM vm);

	/**
	 * Get the default value for a setting.
	 */
	int GetSettingDefaultValue(const char *name);

private:
	AIConfigItemList config_list;
};

class AILibrary : public AIFileInfo {
public:
	/**
	 * Create an AI, using this AIInfo as start-template.
	 */
	static SQInteger Constructor(HSQUIRRELVM vm);

	static SQInteger Import(HSQUIRRELVM vm);
};

#endif /* AI_INFO */