3 Copyright (C) 2010-2016 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2014-2016 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #ifndef REMOTEPLAYER_HEADER
22 #define REMOTEPLAYER_HEADER
25 #include "cloudparams.h"
29 enum RemotePlayerChatResult
31 RPLAYER_CHATRESULT_OK,
32 RPLAYER_CHATRESULT_FLOODING,
33 RPLAYER_CHATRESULT_KICK,
39 class RemotePlayer : public Player
41 friend class PlayerDatabaseFiles;
44 RemotePlayer(const char *name, IItemDefManager *idef);
45 virtual ~RemotePlayer() {}
47 void deSerialize(std::istream &is, const std::string &playername, PlayerSAO *sao);
49 PlayerSAO *getPlayerSAO() { return m_sao; }
50 void setPlayerSAO(PlayerSAO *sao) { m_sao = sao; }
52 const RemotePlayerChatResult canSendChatMessage();
54 void setHotbarItemcount(s32 hotbar_itemcount)
56 hud_hotbar_itemcount = hotbar_itemcount;
59 s32 getHotbarItemcount() const { return hud_hotbar_itemcount; }
61 void overrideDayNightRatio(bool do_override, float ratio)
63 m_day_night_ratio_do_override = do_override;
64 m_day_night_ratio = ratio;
67 void getDayNightRatio(bool *do_override, float *ratio)
69 *do_override = m_day_night_ratio_do_override;
70 *ratio = m_day_night_ratio;
73 void setHotbarImage(const std::string &name) { hud_hotbar_image = name; }
75 std::string getHotbarImage() const { return hud_hotbar_image; }
77 void setHotbarSelectedImage(const std::string &name)
79 hud_hotbar_selected_image = name;
82 const std::string &getHotbarSelectedImage() const
84 return hud_hotbar_selected_image;
87 void setSky(const video::SColor &bgcolor, const std::string &type,
88 const std::vector<std::string> ¶ms, bool &clouds)
90 m_sky_bgcolor = bgcolor;
92 m_sky_params = params;
93 m_sky_clouds = clouds;
96 void getSky(video::SColor *bgcolor, std::string *type,
97 std::vector<std::string> *params, bool *clouds)
99 *bgcolor = m_sky_bgcolor;
101 *params = m_sky_params;
102 *clouds = m_sky_clouds;
105 void setCloudParams(const CloudParams &cloud_params)
107 m_cloud_params = cloud_params;
110 const CloudParams &getCloudParams() const
112 return m_cloud_params;
115 bool checkModified() const { return m_dirty || inventory.checkModified(); }
117 void setModified(const bool x)
121 inventory.setModified(x);
124 void setLocalAnimations(v2s32 frames[4], float frame_speed)
126 for (int i = 0; i < 4; i++)
127 local_animations[i] = frames[i];
128 local_animation_speed = frame_speed;
131 void getLocalAnimations(v2s32 *frames, float *frame_speed)
133 for (int i = 0; i < 4; i++)
134 frames[i] = local_animations[i];
135 *frame_speed = local_animation_speed;
138 void setDirty(bool dirty) { m_dirty = true; }
140 u16 protocol_version;
144 serialize() writes a bunch of text that can contain
145 any characters except a '\0', and such an ending that
146 deSerialize stops reading exactly at the right point.
148 void serialize(std::ostream &os);
149 void serializeExtraAttributes(std::string &output);
154 static bool m_setting_cache_loaded;
155 static float m_setting_chat_message_limit_per_10sec;
156 static u16 m_setting_chat_message_limit_trigger_kick;
158 u32 m_last_chat_message_sent;
159 float m_chat_message_allowance;
160 u16 m_message_rate_overhead;
162 bool m_day_night_ratio_do_override;
163 float m_day_night_ratio;
164 std::string hud_hotbar_image;
165 std::string hud_hotbar_selected_image;
167 std::string m_sky_type;
168 video::SColor m_sky_bgcolor;
169 std::vector<std::string> m_sky_params;
172 CloudParams m_cloud_params;