blob: e3b5508b9db0b7fa4c5f507129d58cfb5a16ad44 (
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
|
// vim:ft=doxygen
namespace crepe {
/**
\defgroup feature_script Scripting basics
\ingroup feature
\brief Create a concrete Script and attach it to a GameObject
Scripts can be used to implement game behavior, and allow arbitrary code to run
as part of the game loop. Scripts are implemented as derivative classes of
Script, which are added to \ref GameObject "game objects" using the \ref
BehaviorScript \ref Component "component".
\see Script
\see BehaviorScript
\see GameObject
\par Example
\note This example assumes you already have a GameObject. If not, read
\"\ref feature_gameobject\" first.
First, define a class (anywhere) that inherits from Script. The Script class
acts as an interface, and has two functions (\ref Script::init "\c init()" and
\ref Script::update "\c update()"), which *may* be implemented (they are empty
by default). From now on, this derivative class will be referred to as a
*concrete script*.
```cpp
#include <crepe/api/Script.h>
#include <crepe/api/BehaviorScript.h>
class MyScript : public crepe::Script {
void init() {
// called once
}
void update() {
// called on fixed update
}
};
```
After defining a concrete script, it can be instantiated and attached to \ref
feature_gameobject "game objects" during \ref feature_scene
"scene initialization" using a BehaviorScript component:
```cpp
using namespace crepe;
GameObject obj;
// Create a BehaviorScript component to hold MyScript
BehaviorScript & behavior_script = obj.add_component<BehaviorScript>();
// Instantiate (and attach) MyScript to behavior_script
behavior_script.set_script<MyScript>();
```
The above can also be done in a single call for convenience:
```cpp
obj.add_component<BehaviorScript>().set_script<MyScript>();
```
*/
}
|