blob: 7b5a3a8a0f01b62e1b835cf1b6dc815bb6f247e8 (
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
|
/*
* Copyright 2008-2009 Ben Boeckel <MathStuf@gmail.com>
*
* This program 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, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file sigcore/Script.h
*/
#ifndef SIGCORE_SCRIPT
#define SIGCORE_SCRIPT
// Sigcore includes
#include "Global.h"
// Qt includes
#include <QtCore/QMetaType>
#include <QtCore/QString>
namespace Sigcore
{
/**
* \class Sigcore::Script Script.h sigcore/Script.h
* \brief Class that describes a script for the game engine.
*/
class SIGCORE_EXPORT Script
{
public:
/**
* Constructor.
*
* \param interpreter The language of the script.
* \param script The code for the script.
*/
explicit Script(const QString& interpreter = "", const QString& script = "");
/**
* Set the language of the script. The default game engine uses Kross <http://kross.dipe.org/> to
* run the scripts. The following values are valid for Kross:
*
* - \b mono -- C# <http://www.mono-project.com/Main_Page>
* - \b falcon -- Falcon <http://www.falconpl.org/>
* - \b javascript -- KDE JavaScript <http://api.kde.org/4.x-api/kdelibs-apidocs/kjs/html/index.html>
* - \b qtscript -- QtScript <http://doc.trolltech.com/latest/qtscript.html>
* - \b java -- Java <http://www.java.com/en/>
* - \b lua -- Lua <http://www.lua.org/>
* - \b php -- PHP <http://www.php.net/>
* - \b python -- Python <http://www.python.org/>
* - \b ruby -- Ruby <http://www.ruby-lang.org/en/>
*
* Other languages may be added in the future.
*
* \param interpreter The language of the script.
*/
void setInterpreter(const QString& interpreter);
/**
*
* \param script The code for the script.
*/
void setScript(const QString& script);
/**
* \sa setInterpreter
*
* \return The language of the script.
*/
QString interpreter() const;
/**
* \sa setScript
*
* \return The code for the script.
*/
QString script() const;
Script& operator=(const Script& rhs);
bool operator==(const Script& rhs) const;
bool operator!=(const Script& rhs) const;
private:
QString m_interpreter;
QString m_script;
};
}
Q_DECLARE_METATYPE(Sigcore::Script)
#endif
|
