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;
39 class ServerActiveObject;
41 class ServerScripting;
44 {Active, Loading} block modifier interface.
46 These are fed into ServerEnvironment at initialization time;
47 ServerEnvironment handles deleting them.
50 class ActiveBlockModifier
53 ActiveBlockModifier() = default;
54 virtual ~ActiveBlockModifier() = default;
56 // Set of contents to trigger on
57 virtual const std::vector<std::string> &getTriggerContents() const = 0;
58 // Set of required neighbors (trigger doesn't happen if none are found)
59 // Empty = do not check neighbors
60 virtual const std::vector<std::string> &getRequiredNeighbors() const = 0;
61 // Trigger interval in seconds
62 virtual float getTriggerInterval() = 0;
63 // Random chance of (1 / return value), 0 is disallowed
64 virtual u32 getTriggerChance() = 0;
65 // Whether to modify chance to simulate time lost by an unnattended block
66 virtual bool getSimpleCatchUp() = 0;
67 // This is called usually at interval for 1/chance of the nodes
68 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
69 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
70 u32 active_object_count, u32 active_object_count_wider){};
75 ActiveBlockModifier *abm;
78 ABMWithState(ActiveBlockModifier *abm_);
81 struct LoadingBlockModifierDef
83 // Set of contents to trigger on
84 std::set<std::string> trigger_contents;
86 bool run_at_every_load = false;
88 virtual ~LoadingBlockModifierDef() = default;
90 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
93 struct LBMContentMapping
95 typedef std::unordered_map<content_t, std::vector<LoadingBlockModifierDef *>> lbm_map;
98 std::vector<LoadingBlockModifierDef *> lbm_list;
100 // Needs to be separate method (not inside destructor),
101 // because the LBMContentMapping may be copied and destructed
102 // many times during operation in the lbm_lookup_map.
103 void deleteContents();
104 void addLBM(LoadingBlockModifierDef *lbm_def, IGameDef *gamedef);
105 const std::vector<LoadingBlockModifierDef *> *lookup(content_t c) const;
111 LBMManager() = default;
114 // Don't call this after loadIntroductionTimes() ran.
115 void addLBMDef(LoadingBlockModifierDef *lbm_def);
117 void loadIntroductionTimes(const std::string ×,
118 IGameDef *gamedef, u32 now);
120 // Don't call this before loadIntroductionTimes() ran.
121 std::string createIntroductionTimesString();
123 // Don't call this before loadIntroductionTimes() ran.
124 void applyLBMs(ServerEnvironment *env, MapBlock *block, u32 stamp);
126 // Warning: do not make this std::unordered_map, order is relevant here
127 typedef std::map<u32, LBMContentMapping> lbm_lookup_map;
130 // Once we set this to true, we can only query,
132 bool m_query_mode = false;
134 // For m_query_mode == false:
135 // The key of the map is the LBM def's name.
136 // TODO make this std::unordered_map
137 std::map<std::string, LoadingBlockModifierDef *> m_lbm_defs;
139 // For m_query_mode == true:
140 // The key of the map is the LBM def's first introduction time.
141 lbm_lookup_map m_lbm_lookup;
143 // Returns an iterator to the LBMs that were introduced
144 // after the given time. This is guaranteed to return
145 // valid values for everything
146 lbm_lookup_map::const_iterator getLBMsIntroducedAfter(u32 time)
147 { return m_lbm_lookup.lower_bound(time); }
151 List of active blocks, used by ServerEnvironment
154 class ActiveBlockList
157 void update(std::vector<PlayerSAO*> &active_players,
158 s16 active_block_range,
159 s16 active_object_range,
160 std::set<v3s16> &blocks_removed,
161 std::set<v3s16> &blocks_added);
163 bool contains(v3s16 p){
164 return (m_list.find(p) != m_list.end());
171 std::set<v3s16> m_list;
172 std::set<v3s16> m_abm_list;
173 std::set<v3s16> m_forceloaded_list;
179 Operation mode for ServerEnvironment::clearObjects()
181 enum ClearObjectsMode {
182 // Load and go through every mapblock, clearing objects
183 CLEAR_OBJECTS_MODE_FULL,
185 // Clear objects immediately in loaded mapblocks;
186 // clear objects in unloaded mapblocks only when the mapblocks are next activated.
187 CLEAR_OBJECTS_MODE_QUICK,
191 The server-side environment.
193 This is not thread-safe. Server uses an environment mutex.
196 typedef std::unordered_map<u16, ServerActiveObject *> ServerActiveObjectMap;
198 class ServerEnvironment : public Environment
201 ServerEnvironment(ServerMap *map, ServerScripting *scriptIface,
202 Server *server, const std::string &path_world);
203 ~ServerEnvironment();
207 ServerMap & getServerMap();
209 //TODO find way to remove this fct!
210 ServerScripting* getScriptIface()
216 float getSendRecommendedInterval()
217 { return m_recommended_send_interval; }
219 void kickAllPlayers(AccessDeniedCode reason,
220 const std::string &str_reason, bool reconnect);
222 void saveLoadedPlayers();
223 void savePlayer(RemotePlayer *player);
224 PlayerSAO *loadPlayer(RemotePlayer *player, bool *new_player, session_t peer_id,
225 bool is_singleplayer);
226 void addPlayer(RemotePlayer *player);
227 void removePlayer(RemotePlayer *player);
228 bool removePlayerFromDatabase(const std::string &name);
231 Save and load time of day and game timer
236 u32 addParticleSpawner(float exptime);
237 u32 addParticleSpawner(float exptime, u16 attached_id);
238 void deleteParticleSpawner(u32 id, bool remove_from_object = true);
241 External ActiveObject interface
242 -------------------------------------------
245 ServerActiveObject* getActiveObject(u16 id);
248 Add an active object to the environment.
249 Environment handles deletion of object.
250 Object may be deleted by environment immediately.
251 If id of object is 0, assigns a free id to it.
252 Returns the id of the object.
253 Returns 0 if not added and thus deleted.
255 u16 addActiveObject(ServerActiveObject *object);
258 * Verify if id is a free active object id
260 * @return true if slot is free
262 bool isFreeServerActiveObjectId(u16 id) const;
265 * Retrieve the first free ActiveObject ID
266 * @return free activeobject ID or 0 if none was found
268 u16 getFreeServerActiveObjectId();
271 Add an active object as a static object to the corresponding
273 Caller allocates memory, ServerEnvironment frees memory.
274 Return value: true if succeeded, false if failed.
275 (note: not used, pending removal from engine)
277 //bool addActiveObjectAsStatic(ServerActiveObject *object);
280 Find out what new objects have been added to
281 inside a radius around a position
283 void getAddedActiveObjects(PlayerSAO *playersao, s16 radius,
285 std::set<u16> ¤t_objects,
286 std::queue<u16> &added_objects);
289 Find out what new objects have been removed from
290 inside a radius around a position
292 void getRemovedActiveObjects(PlayerSAO *playersao, s16 radius,
294 std::set<u16> ¤t_objects,
295 std::queue<u16> &removed_objects);
298 Get the next message emitted by some active object.
299 Returns a message with id=0 if no messages are available.
301 ActiveObjectMessage getActiveObjectMessage();
303 virtual void getSelectedActiveObjects(
304 const core::line3d<f32> &shootline_on_map,
305 std::vector<PointedThing> &objects
309 Activate objects and dynamically modify for the dtime determined
310 from timestamp and additional_dtime
312 void activateBlock(MapBlock *block, u32 additional_dtime=0);
315 {Active,Loading}BlockModifiers
316 -------------------------------------------
319 void addActiveBlockModifier(ActiveBlockModifier *abm);
320 void addLoadingBlockModifierDef(LoadingBlockModifierDef *lbm);
324 -------------------------------------------
327 // Script-aware node setters
328 bool setNode(v3s16 p, const MapNode &n);
329 bool removeNode(v3s16 p);
330 bool swapNode(v3s16 p, const MapNode &n);
332 // Find all active objects inside a radius around a point
333 void getObjectsInsideRadius(std::vector<u16> &objects, v3f pos, float radius);
335 // Clear objects, loading and going through every MapBlock
336 void clearObjects(ClearObjectsMode mode);
338 // This makes stuff happen
339 void step(f32 dtime);
342 * Returns false if the given line intersects with a
343 * non-air node, true otherwise.
344 * \param pos1 start of the line
345 * \param pos2 end of the line
346 * \param p output, position of the first non-air node
347 * the line intersects
349 bool line_of_sight(v3f pos1, v3f pos2, v3s16 *p = NULL);
351 u32 getGameTime() const { return m_game_time; }
353 void reportMaxLagEstimate(float f) { m_max_lag_estimate = f; }
354 float getMaxLagEstimate() { return m_max_lag_estimate; }
356 std::set<v3s16>* getForceloadedBlocks() { return &m_active_blocks.m_forceloaded_list; };
358 // Sets the static object status all the active objects in the specified block
359 // This is only really needed for deleting blocks from the map
360 void setStaticForActiveObjectsInBlock(v3s16 blockpos,
361 bool static_exists, v3s16 static_block=v3s16(0,0,0));
363 RemotePlayer *getPlayer(const session_t peer_id);
364 RemotePlayer *getPlayer(const char* name);
365 u32 getPlayerCount() const { return m_players.size(); }
367 static bool migratePlayersDatabase(const GameParams &game_params,
368 const Settings &cmd_args);
372 * called if env_meta.txt doesn't exist (e.g. new world)
374 void loadDefaultMeta();
376 static PlayerDatabase *openPlayerDatabase(const std::string &name,
377 const std::string &savedir, const Settings &conf);
379 Internal ActiveObject interface
380 -------------------------------------------
384 Add an active object to the environment.
386 Called by addActiveObject.
388 Object may be deleted by environment immediately.
389 If id of object is 0, assigns a free id to it.
390 Returns the id of the object.
391 Returns 0 if not added and thus deleted.
393 u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed, u32 dtime_s);
396 Remove all objects that satisfy (isGone() && m_known_by_count==0)
398 void removeRemovedObjects();
401 Convert stored objects from block to active
403 void activateObjects(MapBlock *block, u32 dtime_s);
406 Convert objects that are not in active blocks to static.
408 If m_known_by_count != 0, active object is not deleted, but static
409 data is still updated.
411 If force_delete is set, active object is deleted nevertheless. It
412 shall only be set so in the destructor of the environment.
414 void deactivateFarObjects(bool force_delete);
417 A few helpers used by the three above methods
419 void deleteStaticFromBlock(
420 ServerActiveObject *obj, u16 id, u32 mod_reason, bool no_emerge);
421 bool saveStaticToBlock(v3s16 blockpos, u16 store_id,
422 ServerActiveObject *obj, const StaticObject &s_obj, u32 mod_reason);
431 ServerScripting* m_script;
435 const std::string m_path_world;
436 // Active object list
437 ServerActiveObjectMap m_active_objects;
438 // Outgoing network message buffer for active objects
439 std::queue<ActiveObjectMessage> m_active_object_messages;
441 float m_send_recommended_timer = 0.0f;
442 IntervalLimiter m_object_management_interval;
443 // List of active blocks
444 ActiveBlockList m_active_blocks;
445 IntervalLimiter m_active_blocks_management_interval;
446 IntervalLimiter m_active_block_modifier_interval;
447 IntervalLimiter m_active_blocks_nodemetadata_interval;
448 int m_active_block_interval_overload_skip = 0;
449 // Time from the beginning of the game in seconds.
450 // Incremented in step().
452 // A helper variable for incrementing the latter
453 float m_game_time_fraction_counter = 0.0f;
454 // Time of last clearObjects call (game time).
455 // When a mapblock older than this is loaded, its objects are cleared.
456 u32 m_last_clear_objects_time = 0;
457 // Active block modifiers
458 std::vector<ABMWithState> m_abms;
459 LBMManager m_lbm_mgr;
460 // An interval for generally sending object positions and stuff
461 float m_recommended_send_interval = 0.1f;
462 // Estimate for general maximum lag as determined by server.
463 // Can raise to high values like 15s with eg. map generation mods.
464 float m_max_lag_estimate = 0.1f;
466 // peer_ids in here should be unique, except that there may be many 0s
467 std::vector<RemotePlayer*> m_players;
469 PlayerDatabase *m_player_database = nullptr;
472 IntervalLimiter m_particle_management_interval;
473 std::unordered_map<u32, float> m_particle_spawners;
474 std::unordered_map<u32, u16> m_particle_spawner_attachments;