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.
20 #ifndef CLIENT_ENVIRONMENT_HEADER
21 #define CLIENT_ENVIRONMENT_HEADER
23 #include <ISceneManager.h>
24 #include "environment.h"
25 #include "clientobject.h"
27 class ClientSimpleObject;
29 class ClientScripting;
30 class ClientActiveObject;
35 The client-side environment.
37 This is not thread-safe.
38 Must be called from main (irrlicht) thread (uses the SceneManager)
39 Client uses an environment mutex.
42 enum ClientEnvEventType
51 ClientEnvEventType type;
65 typedef std::unordered_map<u16, ClientActiveObject*> ClientActiveObjectMap;
66 class ClientEnvironment : public Environment
69 ClientEnvironment(ClientMap *map, ITextureSource *texturesource, Client *client);
73 ClientMap & getClientMap();
75 Client *getGameDef() { return m_client; }
76 void setScript(ClientScripting *script) { m_script = script; }
80 virtual void setLocalPlayer(LocalPlayer *player);
81 LocalPlayer *getLocalPlayer() { return m_local_player; }
87 void addSimpleObject(ClientSimpleObject *simple);
93 GenericCAO* getGenericCAO(u16 id);
94 ClientActiveObject* getActiveObject(u16 id);
97 Adds an active object to the environment.
98 Environment handles deletion of object.
99 Object may be deleted by environment immediately.
100 If id of object is 0, assigns a free id to it.
101 Returns the id of the object.
102 Returns 0 if not added and thus deleted.
104 u16 addActiveObject(ClientActiveObject *object);
106 void addActiveObject(u16 id, u8 type, const std::string &init_data);
107 void removeActiveObject(u16 id);
109 void processActiveObjectMessage(u16 id, const std::string &data);
112 Callbacks for activeobjects
115 void damageLocalPlayer(u8 damage, bool handle_hp=true);
116 void updateLocalPlayerBreath(u16 breath);
119 Client likes to call these
122 // Get all nearby objects
123 void getActiveObjects(v3f origin, f32 max_d,
124 std::vector<DistanceSortedActiveObject> &dest);
126 bool hasClientEnvEvents() const { return !m_client_event_queue.empty(); }
128 // Get event from queue. If queue is empty, it triggers an assertion failure.
129 ClientEnvEvent getClientEnvEvent();
131 virtual void getSelectedActiveObjects(
132 const core::line3d<f32> &shootline_on_map,
133 std::vector<PointedThing> &objects
136 u16 attachement_parent_ids[USHRT_MAX + 1];
138 const std::list<std::string> &getPlayerNames() { return m_player_names; }
139 void addPlayerName(const std::string &name) { m_player_names.push_back(name); }
140 void removePlayerName(const std::string &name) { m_player_names.remove(name); }
141 void updateCameraOffset(v3s16 camera_offset)
142 { m_camera_offset = camera_offset; }
143 v3s16 getCameraOffset() const { return m_camera_offset; }
146 LocalPlayer *m_local_player = nullptr;
147 ITextureSource *m_texturesource;
149 ClientScripting *m_script = nullptr;
150 ClientActiveObjectMap m_active_objects;
151 std::vector<ClientSimpleObject*> m_simple_objects;
152 std::queue<ClientEnvEvent> m_client_event_queue;
153 IntervalLimiter m_active_object_light_update_interval;
154 IntervalLimiter m_lava_hurt_interval;
155 IntervalLimiter m_drowning_interval;
156 IntervalLimiter m_breathing_interval;
157 std::list<std::string> m_player_names;
158 v3s16 m_camera_offset;