3 Copyright (C) 2010-2017 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 Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser 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.
22 #include "activeobject.h"
23 #include "environment.h"
26 #include "util/numeric.h"
36 class ServerEnvironment;
37 class ActiveBlockModifier;
38 class ServerActiveObject;
40 class ServerScripting;
43 {Active, Loading} block modifier interface.
45 These are fed into ServerEnvironment at initialization time;
46 ServerEnvironment handles deleting them.
49 class ActiveBlockModifier
52 ActiveBlockModifier(){};
53 virtual ~ActiveBlockModifier(){};
55 // Set of contents to trigger on
56 virtual const std::set<std::string> &getTriggerContents() const = 0;
57 // Set of required neighbors (trigger doesn't happen if none are found)
58 // Empty = do not check neighbors
59 virtual const std::set<std::string> &getRequiredNeighbors() const = 0;
60 // Trigger interval in seconds
61 virtual float getTriggerInterval() = 0;
62 // Random chance of (1 / return value), 0 is disallowed
63 virtual u32 getTriggerChance() = 0;
64 // Whether to modify chance to simulate time lost by an unnattended block
65 virtual bool getSimpleCatchUp() = 0;
66 // This is called usually at interval for 1/chance of the nodes
67 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
68 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
69 u32 active_object_count, u32 active_object_count_wider){};
74 ActiveBlockModifier *abm;
77 ABMWithState(ActiveBlockModifier *abm_);
80 struct LoadingBlockModifierDef
82 // Set of contents to trigger on
83 std::set<std::string> trigger_contents;
85 bool run_at_every_load = false;
87 virtual ~LoadingBlockModifierDef() {}
88 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
91 struct LBMContentMapping
93 typedef std::unordered_map<content_t, std::vector<LoadingBlockModifierDef *>> lbm_map;
96 std::vector<LoadingBlockModifierDef *> lbm_list;
98 // Needs to be separate method (not inside destructor),
99 // because the LBMContentMapping may be copied and destructed
100 // many times during operation in the lbm_lookup_map.
101 void deleteContents();
102 void addLBM(LoadingBlockModifierDef *lbm_def, IGameDef *gamedef);
103 const std::vector<LoadingBlockModifierDef *> *lookup(content_t c) const;
112 // Don't call this after loadIntroductionTimes() ran.
113 void addLBMDef(LoadingBlockModifierDef *lbm_def);
115 void loadIntroductionTimes(const std::string ×,
116 IGameDef *gamedef, u32 now);
118 // Don't call this before loadIntroductionTimes() ran.
119 std::string createIntroductionTimesString();
121 // Don't call this before loadIntroductionTimes() ran.
122 void applyLBMs(ServerEnvironment *env, MapBlock *block, u32 stamp);
124 // Warning: do not make this std::unordered_map, order is relevant here
125 typedef std::map<u32, LBMContentMapping> lbm_lookup_map;
128 // Once we set this to true, we can only query,
130 bool m_query_mode = false;
132 // For m_query_mode == false:
133 // The key of the map is the LBM def's name.
134 // TODO make this std::unordered_map
135 std::map<std::string, LoadingBlockModifierDef *> m_lbm_defs;
137 // For m_query_mode == true:
138 // The key of the map is the LBM def's first introduction time.
139 lbm_lookup_map m_lbm_lookup;
141 // Returns an iterator to the LBMs that were introduced
142 // after the given time. This is guaranteed to return
143 // valid values for everything
144 lbm_lookup_map::const_iterator getLBMsIntroducedAfter(u32 time)
145 { return m_lbm_lookup.lower_bound(time); }
149 List of active blocks, used by ServerEnvironment
152 class ActiveBlockList
155 void update(std::vector<v3s16> &active_positions,
157 std::set<v3s16> &blocks_removed,
158 std::set<v3s16> &blocks_added);
160 bool contains(v3s16 p){
161 return (m_list.find(p) != m_list.end());
168 std::set<v3s16> m_list;
169 std::set<v3s16> m_forceloaded_list;
175 Operation mode for ServerEnvironment::clearObjects()
177 enum ClearObjectsMode {
178 // Load and go through every mapblock, clearing objects
179 CLEAR_OBJECTS_MODE_FULL,
181 // Clear objects immediately in loaded mapblocks;
182 // clear objects in unloaded mapblocks only when the mapblocks are next activated.
183 CLEAR_OBJECTS_MODE_QUICK,
187 The server-side environment.
189 This is not thread-safe. Server uses an environment mutex.
192 typedef std::unordered_map<u16, ServerActiveObject *> ServerActiveObjectMap;
194 class ServerEnvironment : public Environment
197 ServerEnvironment(ServerMap *map, ServerScripting *scriptIface,
198 Server *server, const std::string &path_world);
199 ~ServerEnvironment();
203 ServerMap & getServerMap();
205 //TODO find way to remove this fct!
206 ServerScripting* getScriptIface()
212 float getSendRecommendedInterval()
213 { return m_recommended_send_interval; }
215 void kickAllPlayers(AccessDeniedCode reason,
216 const std::string &str_reason, bool reconnect);
218 void saveLoadedPlayers();
219 void savePlayer(RemotePlayer *player);
220 PlayerSAO *loadPlayer(RemotePlayer *player, bool *new_player, u16 peer_id,
221 bool is_singleplayer);
222 void addPlayer(RemotePlayer *player);
223 void removePlayer(RemotePlayer *player);
224 bool removePlayerFromDatabase(const std::string &name);
227 Save and load time of day and game timer
231 // to be called instead of loadMeta if
232 // env_meta.txt doesn't exist (e.g. new world)
233 void loadDefaultMeta();
235 u32 addParticleSpawner(float exptime);
236 u32 addParticleSpawner(float exptime, u16 attached_id);
237 void deleteParticleSpawner(u32 id, bool remove_from_object = true);
240 External ActiveObject interface
241 -------------------------------------------
244 ServerActiveObject* getActiveObject(u16 id);
247 Add an active object to the environment.
248 Environment handles deletion of object.
249 Object may be deleted by environment immediately.
250 If id of object is 0, assigns a free id to it.
251 Returns the id of the object.
252 Returns 0 if not added and thus deleted.
254 u16 addActiveObject(ServerActiveObject *object);
257 Add an active object as a static object to the corresponding
259 Caller allocates memory, ServerEnvironment frees memory.
260 Return value: true if succeeded, false if failed.
261 (note: not used, pending removal from engine)
263 //bool addActiveObjectAsStatic(ServerActiveObject *object);
266 Find out what new objects have been added to
267 inside a radius around a position
269 void getAddedActiveObjects(PlayerSAO *playersao, s16 radius,
271 std::set<u16> ¤t_objects,
272 std::queue<u16> &added_objects);
275 Find out what new objects have been removed from
276 inside a radius around a position
278 void getRemovedActiveObjects(PlayerSAO *playersao, s16 radius,
280 std::set<u16> ¤t_objects,
281 std::queue<u16> &removed_objects);
284 Get the next message emitted by some active object.
285 Returns a message with id=0 if no messages are available.
287 ActiveObjectMessage getActiveObjectMessage();
289 virtual void getSelectedActiveObjects(
290 const core::line3d<f32> &shootline_on_map,
291 std::vector<PointedThing> &objects
295 Activate objects and dynamically modify for the dtime determined
296 from timestamp and additional_dtime
298 void activateBlock(MapBlock *block, u32 additional_dtime=0);
301 {Active,Loading}BlockModifiers
302 -------------------------------------------
305 void addActiveBlockModifier(ActiveBlockModifier *abm);
306 void addLoadingBlockModifierDef(LoadingBlockModifierDef *lbm);
310 -------------------------------------------
313 // Script-aware node setters
314 bool setNode(v3s16 p, const MapNode &n);
315 bool removeNode(v3s16 p);
316 bool swapNode(v3s16 p, const MapNode &n);
318 // Find all active objects inside a radius around a point
319 void getObjectsInsideRadius(std::vector<u16> &objects, v3f pos, float radius);
321 // Clear objects, loading and going through every MapBlock
322 void clearObjects(ClearObjectsMode mode);
324 // This makes stuff happen
325 void step(f32 dtime);
327 //check if there's a line of sight between two positions
328 bool line_of_sight(v3f pos1, v3f pos2, float stepsize=1.0, v3s16 *p=NULL);
330 u32 getGameTime() const { return m_game_time; }
332 void reportMaxLagEstimate(float f) { m_max_lag_estimate = f; }
333 float getMaxLagEstimate() { return m_max_lag_estimate; }
335 std::set<v3s16>* getForceloadedBlocks() { return &m_active_blocks.m_forceloaded_list; };
337 // Sets the static object status all the active objects in the specified block
338 // This is only really needed for deleting blocks from the map
339 void setStaticForActiveObjectsInBlock(v3s16 blockpos,
340 bool static_exists, v3s16 static_block=v3s16(0,0,0));
342 RemotePlayer *getPlayer(const u16 peer_id);
343 RemotePlayer *getPlayer(const char* name);
345 static bool migratePlayersDatabase(const GameParams &game_params,
346 const Settings &cmd_args);
349 static PlayerDatabase *openPlayerDatabase(const std::string &name,
350 const std::string &savedir, const Settings &conf);
352 Internal ActiveObject interface
353 -------------------------------------------
357 Add an active object to the environment.
359 Called by addActiveObject.
361 Object may be deleted by environment immediately.
362 If id of object is 0, assigns a free id to it.
363 Returns the id of the object.
364 Returns 0 if not added and thus deleted.
366 u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed, u32 dtime_s);
369 Remove all objects that satisfy (m_removed && m_known_by_count==0)
371 void removeRemovedObjects();
374 Convert stored objects from block to active
376 void activateObjects(MapBlock *block, u32 dtime_s);
379 Convert objects that are not in active blocks to static.
381 If m_known_by_count != 0, active object is not deleted, but static
382 data is still updated.
384 If force_delete is set, active object is deleted nevertheless. It
385 shall only be set so in the destructor of the environment.
387 void deactivateFarObjects(bool force_delete);
396 ServerScripting* m_script;
400 const std::string m_path_world;
401 // Active object list
402 ServerActiveObjectMap m_active_objects;
403 // Outgoing network message buffer for active objects
404 std::queue<ActiveObjectMessage> m_active_object_messages;
406 float m_send_recommended_timer = 0.0f;
407 IntervalLimiter m_object_management_interval;
408 // List of active blocks
409 ActiveBlockList m_active_blocks;
410 IntervalLimiter m_active_blocks_management_interval;
411 IntervalLimiter m_active_block_modifier_interval;
412 IntervalLimiter m_active_blocks_nodemetadata_interval;
413 int m_active_block_interval_overload_skip = 0;
414 // Time from the beginning of the game in seconds.
415 // Incremented in step().
417 // A helper variable for incrementing the latter
418 float m_game_time_fraction_counter = 0.0f;
419 // Time of last clearObjects call (game time).
420 // When a mapblock older than this is loaded, its objects are cleared.
421 u32 m_last_clear_objects_time = 0;
422 // Active block modifiers
423 std::vector<ABMWithState> m_abms;
424 LBMManager m_lbm_mgr;
425 // An interval for generally sending object positions and stuff
426 float m_recommended_send_interval = 0.1f;
427 // Estimate for general maximum lag as determined by server.
428 // Can raise to high values like 15s with eg. map generation mods.
429 float m_max_lag_estimate = 0.1f;
431 // peer_ids in here should be unique, except that there may be many 0s
432 std::vector<RemotePlayer*> m_players;
434 PlayerDatabase *m_player_database = nullptr;
437 IntervalLimiter m_particle_management_interval;
438 std::unordered_map<u32, float> m_particle_spawners;
439 std::unordered_map<u32, u16> m_particle_spawner_attachments;