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"
25 #include "server/serveractiveobjectmap.h"
27 #include "util/numeric.h"
37 class ServerEnvironment;
38 class ActiveBlockModifier;
40 class ServerActiveObject;
42 class ServerScripting;
45 {Active, Loading} block modifier interface.
47 These are fed into ServerEnvironment at initialization time;
48 ServerEnvironment handles deleting them.
51 class ActiveBlockModifier
54 ActiveBlockModifier() = default;
55 virtual ~ActiveBlockModifier() = default;
57 // Set of contents to trigger on
58 virtual const std::vector<std::string> &getTriggerContents() const = 0;
59 // Set of required neighbors (trigger doesn't happen if none are found)
60 // Empty = do not check neighbors
61 virtual const std::vector<std::string> &getRequiredNeighbors() const = 0;
62 // Trigger interval in seconds
63 virtual float getTriggerInterval() = 0;
64 // Random chance of (1 / return value), 0 is disallowed
65 virtual u32 getTriggerChance() = 0;
66 // Whether to modify chance to simulate time lost by an unnattended block
67 virtual bool getSimpleCatchUp() = 0;
68 // This is called usually at interval for 1/chance of the nodes
69 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
70 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
71 u32 active_object_count, u32 active_object_count_wider){};
76 ActiveBlockModifier *abm;
79 ABMWithState(ActiveBlockModifier *abm_);
82 struct LoadingBlockModifierDef
84 // Set of contents to trigger on
85 std::set<std::string> trigger_contents;
87 bool run_at_every_load = false;
89 virtual ~LoadingBlockModifierDef() = default;
91 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
94 struct LBMContentMapping
96 typedef std::unordered_map<content_t, std::vector<LoadingBlockModifierDef *>> lbm_map;
99 std::vector<LoadingBlockModifierDef *> lbm_list;
101 // Needs to be separate method (not inside destructor),
102 // because the LBMContentMapping may be copied and destructed
103 // many times during operation in the lbm_lookup_map.
104 void deleteContents();
105 void addLBM(LoadingBlockModifierDef *lbm_def, IGameDef *gamedef);
106 const std::vector<LoadingBlockModifierDef *> *lookup(content_t c) const;
112 LBMManager() = default;
115 // Don't call this after loadIntroductionTimes() ran.
116 void addLBMDef(LoadingBlockModifierDef *lbm_def);
118 void loadIntroductionTimes(const std::string ×,
119 IGameDef *gamedef, u32 now);
121 // Don't call this before loadIntroductionTimes() ran.
122 std::string createIntroductionTimesString();
124 // Don't call this before loadIntroductionTimes() ran.
125 void applyLBMs(ServerEnvironment *env, MapBlock *block, u32 stamp);
127 // Warning: do not make this std::unordered_map, order is relevant here
128 typedef std::map<u32, LBMContentMapping> lbm_lookup_map;
131 // Once we set this to true, we can only query,
133 bool m_query_mode = false;
135 // For m_query_mode == false:
136 // The key of the map is the LBM def's name.
137 // TODO make this std::unordered_map
138 std::map<std::string, LoadingBlockModifierDef *> m_lbm_defs;
140 // For m_query_mode == true:
141 // The key of the map is the LBM def's first introduction time.
142 lbm_lookup_map m_lbm_lookup;
144 // Returns an iterator to the LBMs that were introduced
145 // after the given time. This is guaranteed to return
146 // valid values for everything
147 lbm_lookup_map::const_iterator getLBMsIntroducedAfter(u32 time)
148 { return m_lbm_lookup.lower_bound(time); }
152 List of active blocks, used by ServerEnvironment
155 class ActiveBlockList
158 void update(std::vector<PlayerSAO*> &active_players,
159 s16 active_block_range,
160 s16 active_object_range,
161 std::set<v3s16> &blocks_removed,
162 std::set<v3s16> &blocks_added);
164 bool contains(v3s16 p){
165 return (m_list.find(p) != m_list.end());
172 std::set<v3s16> m_list;
173 std::set<v3s16> m_abm_list;
174 std::set<v3s16> m_forceloaded_list;
180 Operation mode for ServerEnvironment::clearObjects()
182 enum ClearObjectsMode {
183 // Load and go through every mapblock, clearing objects
184 CLEAR_OBJECTS_MODE_FULL,
186 // Clear objects immediately in loaded mapblocks;
187 // clear objects in unloaded mapblocks only when the mapblocks are next activated.
188 CLEAR_OBJECTS_MODE_QUICK,
192 The server-side environment.
194 This is not thread-safe. Server uses an environment mutex.
197 class ServerEnvironment : public Environment
200 ServerEnvironment(ServerMap *map, ServerScripting *scriptIface,
201 Server *server, const std::string &path_world);
202 ~ServerEnvironment();
206 ServerMap & getServerMap();
208 //TODO find way to remove this fct!
209 ServerScripting* getScriptIface()
215 float getSendRecommendedInterval()
216 { return m_recommended_send_interval; }
218 void kickAllPlayers(AccessDeniedCode reason,
219 const std::string &str_reason, bool reconnect);
221 void saveLoadedPlayers();
222 void savePlayer(RemotePlayer *player);
223 PlayerSAO *loadPlayer(RemotePlayer *player, bool *new_player, session_t peer_id,
224 bool is_singleplayer);
225 void addPlayer(RemotePlayer *player);
226 void removePlayer(RemotePlayer *player);
227 bool removePlayerFromDatabase(const std::string &name);
230 Save and load time of day and game timer
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);
256 void updateActiveObject(ServerActiveObject *object);
259 Add an active object as a static object to the corresponding
261 Caller allocates memory, ServerEnvironment frees memory.
262 Return value: true if succeeded, false if failed.
263 (note: not used, pending removal from engine)
265 //bool addActiveObjectAsStatic(ServerActiveObject *object);
268 Find out what new objects have been added to
269 inside a radius around a position
271 void getAddedActiveObjects(PlayerSAO *playersao, s16 radius,
273 std::set<u16> ¤t_objects,
274 std::queue<u16> &added_objects);
277 Find out what new objects have been removed from
278 inside a radius around a position
280 void getRemovedActiveObjects(PlayerSAO *playersao, s16 radius,
282 std::set<u16> ¤t_objects,
283 std::queue<u16> &removed_objects);
286 Get the next message emitted by some active object.
287 Returns a message with id=0 if no messages are available.
289 ActiveObjectMessage getActiveObjectMessage();
291 virtual void getSelectedActiveObjects(
292 const core::line3d<f32> &shootline_on_map,
293 std::vector<PointedThing> &objects
297 Activate objects and dynamically modify for the dtime determined
298 from timestamp and additional_dtime
300 void activateBlock(MapBlock *block, u32 additional_dtime=0);
303 {Active,Loading}BlockModifiers
304 -------------------------------------------
307 void addActiveBlockModifier(ActiveBlockModifier *abm);
308 void addLoadingBlockModifierDef(LoadingBlockModifierDef *lbm);
312 -------------------------------------------
315 // Script-aware node setters
316 bool setNode(v3s16 p, const MapNode &n);
317 bool removeNode(v3s16 p);
318 bool swapNode(v3s16 p, const MapNode &n);
320 // Find all active objects inside a radius around a point
321 void getObjectsInsideRadius(std::vector<u16> &objects, v3f pos, float radius);
323 // Clear objects, loading and going through every MapBlock
324 void clearObjects(ClearObjectsMode mode);
326 // This makes stuff happen
327 void step(f32 dtime);
330 * Returns false if the given line intersects with a
331 * non-air node, true otherwise.
332 * \param pos1 start of the line
333 * \param pos2 end of the line
334 * \param p output, position of the first non-air node
335 * the line intersects
337 bool line_of_sight(v3f pos1, v3f pos2, v3s16 *p = NULL);
339 u32 getGameTime() const { return m_game_time; }
341 void reportMaxLagEstimate(float f) { m_max_lag_estimate = f; }
342 float getMaxLagEstimate() { return m_max_lag_estimate; }
344 std::set<v3s16>* getForceloadedBlocks() { return &m_active_blocks.m_forceloaded_list; };
346 // Sets the static object status all the active objects in the specified block
347 // This is only really needed for deleting blocks from the map
348 void setStaticForActiveObjectsInBlock(v3s16 blockpos,
349 bool static_exists, v3s16 static_block=v3s16(0,0,0));
351 RemotePlayer *getPlayer(const session_t peer_id);
352 RemotePlayer *getPlayer(const char* name);
353 u32 getPlayerCount() const { return m_players.size(); }
355 static bool migratePlayersDatabase(const GameParams &game_params,
356 const Settings &cmd_args);
360 * called if env_meta.txt doesn't exist (e.g. new world)
362 void loadDefaultMeta();
364 static PlayerDatabase *openPlayerDatabase(const std::string &name,
365 const std::string &savedir, const Settings &conf);
367 Internal ActiveObject interface
368 -------------------------------------------
372 Add an active object to the environment.
374 Called by addActiveObject.
376 Object may be deleted by environment immediately.
377 If id of object is 0, assigns a free id to it.
378 Returns the id of the object.
379 Returns 0 if not added and thus deleted.
381 u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed, u32 dtime_s);
384 Remove all objects that satisfy (isGone() && m_known_by_count==0)
386 void removeRemovedObjects();
389 Convert stored objects from block to active
391 void activateObjects(MapBlock *block, u32 dtime_s);
394 Convert objects that are not in active blocks to static.
396 If m_known_by_count != 0, active object is not deleted, but static
397 data is still updated.
399 If force_delete is set, active object is deleted nevertheless. It
400 shall only be set so in the destructor of the environment.
402 void deactivateFarObjects(bool force_delete);
405 A few helpers used by the three above methods
407 void deleteStaticFromBlock(
408 ServerActiveObject *obj, u16 id, u32 mod_reason, bool no_emerge);
409 bool saveStaticToBlock(v3s16 blockpos, u16 store_id,
410 ServerActiveObject *obj, const StaticObject &s_obj, u32 mod_reason);
419 ServerScripting* m_script;
423 const std::string m_path_world;
424 // Active object list
425 ServerActiveObjectMap m_active_objects;
426 // Outgoing network message buffer for active objects
427 std::queue<ActiveObjectMessage> m_active_object_messages;
429 float m_send_recommended_timer = 0.0f;
430 IntervalLimiter m_object_management_interval;
431 // List of active blocks
432 ActiveBlockList m_active_blocks;
433 IntervalLimiter m_active_blocks_management_interval;
434 IntervalLimiter m_active_block_modifier_interval;
435 IntervalLimiter m_active_blocks_nodemetadata_interval;
436 int m_active_block_interval_overload_skip = 0;
437 // Time from the beginning of the game in seconds.
438 // Incremented in step().
440 // A helper variable for incrementing the latter
441 float m_game_time_fraction_counter = 0.0f;
442 // Time of last clearObjects call (game time).
443 // When a mapblock older than this is loaded, its objects are cleared.
444 u32 m_last_clear_objects_time = 0;
445 // Active block modifiers
446 std::vector<ABMWithState> m_abms;
447 LBMManager m_lbm_mgr;
448 // An interval for generally sending object positions and stuff
449 float m_recommended_send_interval = 0.1f;
450 // Estimate for general maximum lag as determined by server.
451 // Can raise to high values like 15s with eg. map generation mods.
452 float m_max_lag_estimate = 0.1f;
454 // peer_ids in here should be unique, except that there may be many 0s
455 std::vector<RemotePlayer*> m_players;
457 PlayerDatabase *m_player_database = nullptr;
460 IntervalLimiter m_particle_management_interval;
461 std::unordered_map<u32, float> m_particle_spawners;
462 std::unordered_map<u32, u16> m_particle_spawner_attachments;