blob: ba8aa72022584a3dcdc1cdfb244b4217d7fc8deb (
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
65
|
/*
intro/example.h
This file is part of the Osirion project and is distributed under
the terms of the GNU General Public License version 2
*/
#ifndef __INCLUDED_EXAMPLE_H__
#define __INCLUDED_EXAMPLE_H__
// import core functionality
#include "core/core.h"
// console functions
#include "sys/sys.h"
/// example game module
/** This is the osirion Project example module. It describes
* how to create custom modules and how to use the engine functionality.
*/
namespace example
{
/// example game module
/** Every game module derives from core::Module and has to implement a
* number of virtual functions
*/
class Example : public core::Module
{
public:
/// constructor, called on module load
/** Modules are loaded at the start of the program,
* the constructor is only called once.
*/
Example();
/// desctructor, called on module unload
~Example();
/// called once every server frame
/** @param elapsed time elapsed since the precious server frame, in seconds
*/
void frame(float elapsed);
/// called when a player connects
void player_connect(core::Player *player);
/// called when a player disconnects
void player_disconnect(core::Player *player);
protected:
/// called when the game starts
void init();
/// called when the game is shut down
void shutdown();
private:
core::Zone *zone;
};
}
#endif // __INCLUDED_EXAMPLE_H__
|
