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
|
/* $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 script_info.hpp ScriptInfo keeps track of all information of a script, like Author, Description, ... */
#ifndef SCRIPT_INFO
#define SCRIPT_INFO
#include <squirrel.h>
#include "../misc/countedptr.hpp"
class ScriptFileInfo : public SimpleCountedObject {
public:
ScriptFileInfo() :
SQ_instance(NULL),
main_script(NULL),
author(NULL),
name(NULL),
short_name(NULL),
description(NULL),
date(NULL),
instance_name(NULL),
version(0),
url(NULL)
{}
~ScriptFileInfo();
/**
* Get the Author of the script.
*/
const char *GetAuthor() const { return this->author; }
/**
* Get the Name of the script.
*/
const char *GetName() const { return this->name; }
/**
* Get the 4 character long short name of the script.
*/
const char *GetShortName() const { return this->short_name; }
/**
* Get the description of the script.
*/
const char *GetDescription() const { return this->description; }
/**
* Get the version of the script.
*/
int GetVersion() const { return this->version; }
/**
* Get the last-modified date of the script.
*/
const char *GetDate() const { return this->date; }
/**
* Get the name of the instance of the script to create.
*/
const char *GetInstanceName() const { return this->instance_name; }
/**
* Get the website for this script.
*/
const char *GetURL() const { return this->url; }
/**
* Get the filename of the main.nut script.
*/
const char *GetMainScript() const { return this->main_script; }
/**
* Check if a given method exists.
*/
bool CheckMethod(const char *name) const;
/**
* Process the creation of a FileInfo object.
*/
static SQInteger Constructor(HSQUIRRELVM vm, ScriptFileInfo *info);
protected:
class Squirrel *engine;
HSQOBJECT *SQ_instance;
private:
char *main_script;
const char *author;
const char *name;
const char *short_name;
const char *description;
const char *date;
const char *instance_name;
int version;
const char *url;
};
#endif /* SCRIPT_INFO */
|
