3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef SERVEROBJECT_HEADER
21 #define SERVEROBJECT_HEADER
23 #include "common_irrlicht.h"
24 #include "activeobject.h"
32 * Server environment adds an active object, which gets the id 1
33 * The active object list is scanned for each client once in a while,
34 and it finds out what objects have been added that are not known
35 by the client yet. This scan is initiated by the server and the
36 result ends up directly to the server.
37 * A network packet is created with the info and sent to the client.
41 class ServerEnvironment;
43 class ServerActiveObject : public ActiveObject
46 ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos=v3f(0,0,0));
47 virtual ~ServerActiveObject();
51 return m_base_position;
54 void setBasePosition(v3f pos)
56 m_base_position = pos;
59 ServerEnvironment* getEnv()
66 Messages added to messages are sent to client over network.
68 virtual void step(float dtime, Queue<ActiveObjectMessage> &messages){}
71 The return value of this is passed to the client-side object
74 virtual std::string getClientInitializationData(){return "";}
77 The return value of this is passed to the server-side object
78 when it is loaded from disk or from a static object
80 virtual std::string getServerInitializationData(){return "";}
83 This takes the return value of getServerInitializationData
85 virtual void initialize(const std::string &data){}
87 // Number of players which know about this object
90 Whether this object is to be removed when nobody knows about
92 Removal is delayed to preserve the id for the time during which
93 it could be confused to some other object by some client.
98 ServerEnvironment *m_env;
102 class TestSAO : public ServerActiveObject
105 TestSAO(ServerEnvironment *env, u16 id, v3f pos);
108 return ACTIVEOBJECT_TYPE_TEST;
110 void step(float dtime, Queue<ActiveObjectMessage> &messages);
122 class LuaSAO : public ServerActiveObject
125 LuaSAO(ServerEnvironment *env, u16 id, v3f pos);
130 return ACTIVEOBJECT_TYPE_LUA;
133 virtual std::string getClientInitializationData();
134 virtual std::string getServerInitializationData();
136 void initializeFromNothing(const std::string &script_name);
137 void initializeFromSave(const std::string &data);
139 void loadScripts(const std::string &script_name);
141 void step(float dtime, Queue<ActiveObjectMessage> &messages);
144 Stuff available for usage for the lua callbacks
146 // This is moved onwards at the end of step()
147 Queue<ActiveObjectMessage> m_message_queue;
151 std::string m_script_name;