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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/**
* @file script.hpp
* Manages all Lua scripts.
*
* Copyright (C) 2019 Belle-Isle, Andrew <drumsetmonkey@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/>.
*/
#ifndef SYSTEM_SCRIPT_HPP_
#define SYSTEM_SCRIPT_HPP_
#include <entityx/entityx.h>
#include <sol/sol.hpp>
#include "world.hpp"
/**
* Utility for pairing class instances to their member function calls.
* This is useful for adding functions to the Lua game namespace.
*
* @param func The member function to call
* @param instance The instance to bind to
* @return A function that calls the member function using the given instance
*/
template<class C, typename R, typename... Args>
auto bindInstance(R (C::* func)(Args...), C *instance)
{
return [instance, func](Args... args) { (instance->*func)(args...); };
}
struct EntitySpawnEvent
{
sol::object ref;
EntitySpawnEvent(sol::object _ref) :
ref(_ref) {}
};
/**
* @class ScriptSystem
* Handles all the game's scripting requests
*/
class ScriptSystem : public entityx::System<ScriptSystem>,
public entityx::Receiver<ScriptSystem>
{
private:
/**
* The script systems internal lua state that handles all
* interactions between C and Lua
*/
sol::state lua;
sol::table game;
entityx::EntityManager& manager;
// TODO possibly emit events to spawn worlds instead of passing the
// world system around like a toy
WorldSystem &worldSystem;
public:
ScriptSystem(entityx::EntityManager& _mg, WorldSystem& _ws):
manager(_mg), worldSystem(_ws) {}
~ScriptSystem(void) {}
/**
* Prepares the system for running.
*/
void configure(entityx::EntityManager& entities,
entityx::EventManager& events) final;
/**
* Updates the scripting system.
*/
void update(entityx::EntityManager& entites,
entityx::EventManager& events,
entityx::TimeDelta dt) final;
/**
* Receives all entity spawning events and manages the
* script counterpart.
*/
void receive(const EntitySpawnEvent &toSpawn);
/**
* Initializes the lua states and libraries.
* @return Zero on success, non-zero on error
*/
int init(void);
/**
* Run the initialization file.
*/
void doFile(void);
/**
* The function called by lua scripts in order to spawn an entity.
* @param param The table that must be passed in by Lua. This is a
* sol2 object instead of a sol2 table because this allows us to handle
* errors easier instead of letting sol2 do the error handling.
*/
sol::table spawn(sol::object param);
/**
* Contains all calls that export components/functions to lua.
*/
void scriptExport(void);
template<typename F>
void addToGameNamespace(const std::string& name, F func) {
game.set_function(name, func);
}
};
#endif // SYSTEM_SCRIPT_HPP_
|
