ScummVM API documentation
base_script_holder.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 file is based on WME Lite.
24 * http://dead-code.org/redir.php?target=wmelite
25 * Copyright (c) 2011 Jan Nedoma
26 */
27
28#ifndef WINTERMUTE_BASE_SCRIPTHOLDER_H
29#define WINTERMUTE_BASE_SCRIPTHOLDER_H
30
31#include "engines/wintermute/coll_templ.h"
32#include "engines/wintermute/persistent.h"
33#include "engines/wintermute/base/base_scriptable.h"
34
35namespace Wintermute {
36
38public:
39 DECLARE_PERSISTENT(BaseScriptHolder, BaseScriptable)
40
42 ~BaseScriptHolder() override;
43
44 ScScript *invokeMethodThread(const char *methodName) override;
45 virtual void makeFreezable(bool freezable);
46 bool canHandleEvent(const char *eventName);
47 bool canHandleMethod(const char *eventMethod) override;
48 bool cleanup();
49 bool removeScript(ScScript *script);
50 bool addScript(const char *filename);
51 bool saveAsText(BaseDynamicBuffer *buffer, int indent) override;
52 virtual bool listen(BaseScriptHolder *param1, uint32 param2);
53 bool applyEvent(const char *eventName, bool unbreakable = false);
54 void setFilename(const char *filename);
55 bool parseProperty(char *buffer, bool complete = true);
56
57 char *_filename;
58 bool _freezable;
59 bool _ready{};
60 BaseArray<ScScript *> _scripts;
61
62 // scripting interface
63 ScValue *scGetProperty(const char *name) override;
64 bool scSetProperty(const char *name, ScValue *value) override;
65 bool scCallMethod(ScScript *script, ScStack *stack, ScStack *thisStack, const char *name) override;
66 const char *scToString() override;
67 void scDebuggerDesc(char *buf, int bufSize) override;
68
69 // IWmeObject
70public:
71 virtual bool sendEvent(const char *eventName);
72};
73
74} // End of namespace Wintermute
75
76#endif
Definition: coll_templ.h:345
Definition: base_dynamic_buffer.h:35
Definition: base_game.h:79
Definition: base_script_holder.h:37
Definition: base_scriptable.h:41
Definition: script.h:44
Definition: script_stack.h:41
Definition: script_value.h:42