src/remoteplayer.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2016 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2014-2016 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   5
   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.
  10
  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.
  15
  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.
  19 */
  20
  21 #pragma once
  22
  23 #include "player.h"
  24 #include "skyparams.h"
  25 #include "lighting.h"
  26
  27 class PlayerSAO;
  28
  29 enum RemotePlayerChatResult
  30 {
  31         RPLAYER_CHATRESULT_OK,
  32         RPLAYER_CHATRESULT_FLOODING,
  33         RPLAYER_CHATRESULT_KICK,
  34 };
  35
  36 /*
  37         Player on the server
  38 */
  39 class RemotePlayer : public Player
  40 {
  41         friend class PlayerDatabaseFiles;
  42
  43 public:
  44         RemotePlayer(const char *name, IItemDefManager *idef);
  45         virtual ~RemotePlayer() = default;
  46
  47         PlayerSAO *getPlayerSAO() { return m_sao; }
  48         void setPlayerSAO(PlayerSAO *sao) { m_sao = sao; }
  49
  50         RemotePlayerChatResult canSendChatMessage();
  51
  52         void setHotbarItemcount(s32 hotbar_itemcount)
  53         {
  54                 hud_hotbar_itemcount = hotbar_itemcount;
  55         }
  56
  57         s32 getHotbarItemcount() const { return hud_hotbar_itemcount; }
  58
  59         void overrideDayNightRatio(bool do_override, float ratio)
  60         {
  61                 m_day_night_ratio_do_override = do_override;
  62                 m_day_night_ratio = ratio;
  63         }
  64
  65         void getDayNightRatio(bool *do_override, float *ratio)
  66         {
  67                 *do_override = m_day_night_ratio_do_override;
  68                 *ratio = m_day_night_ratio;
  69         }
  70
  71         void setHotbarImage(const std::string &name) { hud_hotbar_image = name; }
  72
  73         const std::string &getHotbarImage() const { return hud_hotbar_image; }
  74
  75         void setHotbarSelectedImage(const std::string &name)
  76         {
  77                 hud_hotbar_selected_image = name;
  78         }
  79
  80         const std::string &getHotbarSelectedImage() const
  81         {
  82                 return hud_hotbar_selected_image;
  83         }
  84
  85         void setSky(const SkyboxParams &skybox_params)
  86         {
  87                 m_skybox_params = skybox_params;
  88         }
  89
  90         const SkyboxParams &getSkyParams() const { return m_skybox_params; }
  91
  92         void setSun(const SunParams &sun_params) { m_sun_params = sun_params; }
  93
  94         const SunParams &getSunParams() const { return m_sun_params; }
  95
  96         void setMoon(const MoonParams &moon_params) { m_moon_params = moon_params; }
  97
  98         const MoonParams &getMoonParams() const { return m_moon_params; }
  99
 100         void setStars(const StarParams &star_params) { m_star_params = star_params; }
 101
 102         const StarParams &getStarParams() const { return m_star_params; }
 103
 104         void setCloudParams(const CloudParams &cloud_params)
 105         {
 106                 m_cloud_params = cloud_params;
 107         }
 108
 109         const CloudParams &getCloudParams() const { return m_cloud_params; }
 110
 111         bool checkModified() const { return m_dirty || inventory.checkModified(); }
 112
 113         inline void setModified(const bool x) { m_dirty = x; }
 114
 115         void setLocalAnimations(v2s32 frames[4], float frame_speed)
 116         {
 117                 for (int i = 0; i < 4; i++)
 118                         local_animations[i] = frames[i];
 119                 local_animation_speed = frame_speed;
 120         }
 121
 122         void getLocalAnimations(v2s32 *frames, float *frame_speed)
 123         {
 124                 for (int i = 0; i < 4; i++)
 125                         frames[i] = local_animations[i];
 126                 *frame_speed = local_animation_speed;
 127         }
 128
 129         void setLighting(const Lighting &lighting) { m_lighting = lighting; }
 130
 131         const Lighting& getLighting() const { return m_lighting; }
 132
 133         void setDirty(bool dirty) { m_dirty = true; }
 134
 135         u16 protocol_version = 0;
 136         u16 formspec_version = 0;
 137
 138         session_t getPeerId() const { return m_peer_id; }
 139
 140         void setPeerId(session_t peer_id) { m_peer_id = peer_id; }
 141
 142         void onSuccessfulSave();
 143
 144 private:
 145         PlayerSAO *m_sao = nullptr;
 146         bool m_dirty = false;
 147
 148         static bool m_setting_cache_loaded;
 149         static float m_setting_chat_message_limit_per_10sec;
 150         static u16 m_setting_chat_message_limit_trigger_kick;
 151
 152         u32 m_last_chat_message_sent = std::time(0);
 153         float m_chat_message_allowance = 5.0f;
 154         u16 m_message_rate_overhead = 0;
 155
 156         bool m_day_night_ratio_do_override = false;
 157         float m_day_night_ratio;
 158         std::string hud_hotbar_image = "";
 159         std::string hud_hotbar_selected_image = "";
 160
 161         CloudParams m_cloud_params;
 162
 163         SkyboxParams m_skybox_params;
 164         SunParams m_sun_params;
 165         MoonParams m_moon_params;
 166         StarParams m_star_params;
 167
 168         Lighting m_lighting;
 169
 170         session_t m_peer_id = PEER_ID_INEXISTENT;
 171 };