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 "irrlichttypes.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 class and
36 the result ends up directly to the server.
37 * A network packet is created with the info and sent to the client.
38 * Environment converts objects to static data and static data to
39 objects, based on how close players are to them.
43 class ServerEnvironment;
47 class ServerActiveObject : public ActiveObject
51 NOTE: m_env can be NULL, but step() isn't called if it is.
52 Prototypes are used that way.
54 ServerActiveObject(ServerEnvironment *env, v3f pos);
55 virtual ~ServerActiveObject();
57 virtual void addedToEnvironment(u16 id);
59 // Create a certain type of ServerActiveObject
60 static ServerActiveObject* create(u8 type,
61 ServerEnvironment *env, u16 id, v3f pos,
62 const std::string &data);
65 Some simple getters/setters
67 v3f getBasePosition(){ return m_base_position; }
68 void setBasePosition(v3f pos){ m_base_position = pos; }
69 ServerEnvironment* getEnv(){ return m_env; }
72 Some more dynamic interface
75 virtual void setPos(v3f pos)
76 { setBasePosition(pos); }
77 // continuous: if true, object does not stop immediately at pos
78 virtual void moveTo(v3f pos, bool continuous)
79 { setBasePosition(pos); }
80 // If object has moved less than this and data has not changed,
81 // saving to disk may be omitted
82 virtual float getMinimumSavedMovement()
85 virtual bool isPeaceful(){return true;}
87 virtual std::string getDescription(){return "SAO";}
91 Messages added to messages are sent to client over network.
94 True at around 5-10 times a second, same for all objects.
95 This is used to let objects send most of the data at the
96 same time so that the data can be combined in a single
99 virtual void step(float dtime, bool send_recommended){}
102 The return value of this is passed to the client-side object
105 virtual std::string getClientInitializationData(){return "";}
108 The return value of this is passed to the server-side object
109 when it is created (converted from static to active - actually
110 the data is the static form)
112 virtual std::string getStaticData(){return "";}
114 virtual void punch(ServerActiveObject *puncher){}
115 virtual void rightClick(ServerActiveObject *clicker){}
117 // Returns a reference
118 virtual InventoryItem* getWieldedItem()
120 virtual void damageWieldedItem(u16 amount)
122 // If all fits, eats item and returns true. Otherwise returns false.
123 virtual bool addToInventory(InventoryItem *item)
125 virtual void setHP(s16 hp)
131 Number of players which know about this object. Object won't be
132 deleted until this is 0 to keep the id preserved for the right
135 u16 m_known_by_count;
138 - Whether this object is to be removed when nobody knows about
140 - Removal is delayed to preserve the id for the time during which
141 it could be confused to some other object by some client.
142 - This is set to true by the step() method when the object wants
144 - This can be set to true by anything else too.
149 This is set to true when a block should be removed from the active
150 object list but couldn't be removed because the id has to be
151 reserved for some client.
153 The environment checks this periodically. If this is true and also
154 m_known_by_count is true,
156 bool m_pending_deactivation;
159 Whether the object's static data has been stored to a block
161 bool m_static_exists;
163 The block from which the object was loaded from, and in which
164 a copy of the static data resides.
166 v3s16 m_static_block;
169 Queue of messages to be sent to the client
171 Queue<ActiveObjectMessage> m_messages_out;
174 // Used for creating objects based on type
175 typedef ServerActiveObject* (*Factory)
176 (ServerEnvironment *env, v3f pos,
177 const std::string &data);
178 static void registerType(u16 type, Factory f);
180 ServerEnvironment *m_env;
184 // Used for creating objects based on type
185 static core::map<u16, Factory> m_types;