ScummVM API documentation
luacallback.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_LUACALLBACK_H
32 #define SWORD25_LUACALLBACK_H
33 
34 #include "sword25/kernel/common.h"
35 
36 struct lua_State;
37 
38 namespace Sword25 {
39 
40 class LuaCallback {
41 public:
43  virtual ~LuaCallback();
44 
45  // Funktion muss auf dem Lua-Stack liegen.
46  void registerCallbackFunction(lua_State *L, uint objectHandle);
47 
48  // Funktion muss auf dem Lua-Stack liegen.
49  void unregisterCallbackFunction(lua_State *L, uint objectHandle);
50 
51  void removeAllObjectCallbacks(lua_State *L, uint objectHandle);
52 
53  void invokeCallbackFunctions(lua_State *L, uint objectHandle);
54 
55 protected:
56  virtual int preFunctionInvokation(lua_State *L) {
57  return 0;
58  }
59 
60 private:
61  void ensureObjectCallbackTableExists(lua_State *L, uint objectHandle);
62  void pushCallbackTable(lua_State *L);
63  void pushObjectCallbackTable(lua_State *L, uint objectHandle);
64 };
65 
66 } // End of namespace Sword25
67 
68 #endif
Definition: lstate.h:100
Definition: console.h:27
Definition: luacallback.h:40