1

/* $Id$ */

     2

     3

/** @file ai_info.hpp AIInfo keeps track of all information of an AI, like Author, Description, ... */

     4

     5

#ifndef AI_INFO

     6

#define AI_INFO

     7

     8

class AIFileInfo {

     9

public:

    10

	friend class AIInfo;

    11

	friend class AILibrary;

    12

    13

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

    14

	~AIFileInfo();

    15

    16

	/**

    17

	 * Get the Author of the AI.

    18

	 */

    19

	const char *GetAuthor();

    20

    21

	/**

    22

	 * Get the Name of the AI.

    23

	 */

    24

	const char *GetName();

    25

    26

	/**

    27

	 * Get the description of the AI.

    28

	 */

    29

	const char *GetDescription();

    30

    31

	/**

    32

	 * Get the version of the AI.

    33

	 */

    34

	int GetVersion();

    35

    36

	/**

    37

	 * Get the date of the AI.

    38

	 */

    39

	const char *GetDate();

    40

    41

	/**

    42

	 * Get the name of the instance of the AI to create.

    43

	 */

    44

	const char *GetInstanceName();

    45

    46

	/**

    47

	 * Check if we can start this AI.

    48

	 */

    49

	bool AllowStartup();

    50

    51

	/**

    52

	 * Create an instance of this AI.

    53

	 */

    54

	class AIController *CreateInstance();

    55

    56

	/**

    57

	 * Get the name of the dir this AI is in.

    58

	 */

    59

	const char *GetDirName();

    60

    61

	/**

    62

	 * Get the complete script name of this AI.

    63

	 */

    64

	const char *GetScriptName();

    65

    66

	/**

    67

	 * Check if a given method exists.

    68

	 */

    69

	void CheckMethods(SQInteger *res, const char *name);

    70

    71

	/**

    72

	 * Process the creation of a FileInfo object.

    73

	 */

    74

	static SQInteger Constructor(HSQUIRRELVM vm, AIFileInfo *info);

    75

    76

private:

    77

	Squirrel *engine;

    78

	HSQOBJECT *SQ_instance;

    79

	char *script_name;

    80

	char *dir_name;

    81

	class AISquirrel *base;

    82

	const char *author;

    83

	const char *name;

    84

	const char *description;

    85

	const char *date;

    86

	const char *instance_name;

    87

};

    88

    89

class AIInfo : public AIFileInfo {

    90

public:

    91

	/**

    92

	 * Create an AI, using this AIInfo as start-template.

    93

	 */

    94

	static SQInteger Constructor(HSQUIRRELVM vm);

    95

};

    96

    97

class AILibrary : public AIFileInfo {

    98

public:

    99

	/**

   100

	 * Create an AI, using this AIInfo as start-template.

   101

	 */

   102

	static SQInteger Constructor(HSQUIRRELVM vm);

   103

   104

	static SQInteger Import(HSQUIRRELVM vm);

   105

};

   106

   107

#endif /* AI_INFO */