ScummVM API documentation
script.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22/*
23 * This code is based on Broken Sword 2.5 engine
24 *
25 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
26 *
27 * Licensed under GNU GPL v2
28 *
29 */
30
31#ifndef SWORD25_SCRIPT_H
32#define SWORD25_SCRIPT_H
33
34#include "common/array.h"
35#include "common/str.h"
36#include "sword25/kernel/common.h"
37#include "sword25/kernel/service.h"
38#include "sword25/kernel/persistable.h"
39
40namespace Sword25 {
41
42class Kernel;
43class OutputPersistenceBlock;
44class BS_InputPersistenceBlock;
45
46class ScriptEngine : public Service, public Persistable {
47public:
48 ScriptEngine(Kernel *KernelPtr) : Service(KernelPtr) {}
49 ~ScriptEngine() override {}
50
51 // -----------------------------------------------------------------------------
52 // This method must be implemented by the script engine
53 // -----------------------------------------------------------------------------
54
58 virtual bool init() = 0;
59
64 virtual bool executeFile(const Common::String &fileName) = 0;
65
70 virtual bool executeString(const Common::String &code) = 0;
71
76 virtual void *getScriptObject() = 0;
77
84 virtual void setCommandLine(const Common::Array<Common::String> &commandLineParameters) = 0;
85
86 bool persist(OutputPersistenceBlock &writer) override = 0;
87 bool unpersist(InputPersistenceBlock &reader) override = 0;
88};
89
90} // End of namespace Sword25
91
92#endif
Definition: str.h:59
Definition: inputpersistenceblock.h:40
Definition: kernel.h:72
Definition: outputpersistenceblock.h:39
Definition: persistable.h:39
Definition: script.h:46
virtual bool init()=0
virtual void setCommandLine(const Common::Array< Common::String > &commandLineParameters)=0
virtual bool executeString(const Common::String &code)=0
virtual bool executeFile(const Common::String &fileName)=0
virtual void * getScriptObject()=0
Definition: service.h:54
Definition: console.h:27