src/content_sao.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef CONTENT_SAO_HEADER
  21 #define CONTENT_SAO_HEADER
  22
  23 #include "serverobject.h"
  24 #include "content_object.h"
  25 #include "itemgroup.h"
  26 #include "player.h"
  27 #include "object_properties.h"
  28
  29 ServerActiveObject* createItemSAO(ServerEnvironment *env, v3f pos,
  30                 const std::string itemstring);
  31
  32 /*
  33         LuaEntitySAO needs some internals exposed.
  34 */
  35
  36 class LuaEntitySAO : public ServerActiveObject
  37 {
  38 public:
  39         LuaEntitySAO(ServerEnvironment *env, v3f pos,
  40                         const std::string &name, const std::string &state);
  41         ~LuaEntitySAO();
  42         u8 getType() const
  43         { return ACTIVEOBJECT_TYPE_LUAENTITY; }
  44         u8 getSendType() const
  45         { return ACTIVEOBJECT_TYPE_GENERIC; }
  46         virtual void addedToEnvironment(u32 dtime_s);
  47         static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
  48                         const std::string &data);
  49         void step(float dtime, bool send_recommended);
  50         std::string getClientInitializationData();
  51         std::string getStaticData();
  52         int punch(v3f dir,
  53                         const ToolCapabilities *toolcap=NULL,
  54                         ServerActiveObject *puncher=NULL,
  55                         float time_from_last_punch=1000000);
  56         void rightClick(ServerActiveObject *clicker);
  57         void setPos(v3f pos);
  58         void moveTo(v3f pos, bool continuous);
  59         float getMinimumSavedMovement();
  60         std::string getDescription();
  61         void setHP(s16 hp);
  62         s16 getHP() const;
  63         void setArmorGroups(const ItemGroupList &armor_groups);
  64         void setAnimations(v2f frames, float frame_speed, float frame_blend);
  65         void setBonePosRot(std::string bone, v3f position, v3f rotation);
  66         void setAttachment(ServerActiveObject *parent, std::string bone, v3f position, v3f rotation);
  67         ObjectProperties* accessObjectProperties();
  68         void notifyObjectPropertiesModified();
  69         /* LuaEntitySAO-specific */
  70         void setVelocity(v3f velocity);
  71         v3f getVelocity();
  72         void setAcceleration(v3f acceleration);
  73         v3f getAcceleration();
  74         void setYaw(float yaw);
  75         float getYaw();
  76         void setTextureMod(const std::string &mod);
  77         void setSprite(v2s16 p, int num_frames, float framelength,
  78                         bool select_horiz_by_yawpitch);
  79         std::string getName();
  80 private:
  81         std::string getPropertyPacket();
  82         void sendPosition(bool do_interpolate, bool is_movement_end);
  83
  84         std::string m_init_name;
  85         std::string m_init_state;
  86         bool m_registered;
  87         struct ObjectProperties m_prop;
  88
  89         s16 m_hp;
  90         v3f m_velocity;
  91         v3f m_acceleration;
  92         float m_yaw;
  93         ItemGroupList m_armor_groups;
  94
  95         bool m_properties_sent;
  96         float m_last_sent_yaw;
  97         v3f m_last_sent_position;
  98         v3f m_last_sent_velocity;
  99         float m_last_sent_position_timer;
 100         float m_last_sent_move_precision;
 101         bool m_armor_groups_sent;
 102 };
 103
 104 /*
 105         PlayerSAO needs some internals exposed.
 106 */
 107
 108 class PlayerSAO : public ServerActiveObject
 109 {
 110 public:
 111         PlayerSAO(ServerEnvironment *env_, Player *player_, u16 peer_id_,
 112                         const std::set<std::string> &privs, bool is_singleplayer);
 113         ~PlayerSAO();
 114         u8 getType() const
 115         { return ACTIVEOBJECT_TYPE_PLAYER; }
 116         u8 getSendType() const
 117         { return ACTIVEOBJECT_TYPE_GENERIC; }
 118         std::string getDescription();
 119
 120         /*
 121                 Active object <-> environment interface
 122         */
 123
 124         void addedToEnvironment(u32 dtime_s);
 125         void removingFromEnvironment();
 126         bool isStaticAllowed() const;
 127         bool unlimitedTransferDistance() const;
 128         std::string getClientInitializationData();
 129         std::string getStaticData();
 130         void step(float dtime, bool send_recommended);
 131         void setBasePosition(const v3f &position);
 132         void setPos(v3f pos);
 133         void moveTo(v3f pos, bool continuous);
 134
 135         /*
 136                 Interaction interface
 137         */
 138
 139         int punch(v3f dir,
 140                 const ToolCapabilities *toolcap,
 141                 ServerActiveObject *puncher,
 142                 float time_from_last_punch);
 143         void rightClick(ServerActiveObject *clicker);
 144         s16 getHP() const;
 145         void setHP(s16 hp);
 146
 147         void setArmorGroups(const ItemGroupList &armor_groups);
 148         void setAnimations(v2f frames, float frame_speed, float frame_blend);
 149         void setBonePosRot(std::string bone, v3f position, v3f rotation);
 150         void setAttachment(ServerActiveObject *parent, std::string bone, v3f position, v3f rotation);
 151         ObjectProperties* accessObjectProperties();
 152         void notifyObjectPropertiesModified();
 153
 154         /*
 155                 Inventory interface
 156         */
 157
 158         Inventory* getInventory();
 159         const Inventory* getInventory() const;
 160         InventoryLocation getInventoryLocation() const;
 161         void setInventoryModified();
 162         std::string getWieldList() const;
 163         int getWieldIndex() const;
 164         void setWieldIndex(int i);
 165
 166         /*
 167                 PlayerSAO-specific
 168         */
 169
 170         void disconnected();
 171
 172         Player* getPlayer()
 173         {
 174                 return m_player;
 175         }
 176         u16 getPeerID() const
 177         {
 178                 return m_peer_id;
 179         }
 180
 181         // Cheat prevention
 182
 183         v3f getLastGoodPosition() const
 184         {
 185                 return m_last_good_position;
 186         }
 187         float resetTimeFromLastPunch()
 188         {
 189                 float r = m_time_from_last_punch;
 190                 m_time_from_last_punch = 0.0;
 191                 return r;
 192         }
 193         void noCheatDigStart(v3s16 p)
 194         {
 195                 m_nocheat_dig_pos = p;
 196                 m_nocheat_dig_time = 0;
 197         }
 198         v3s16 getNoCheatDigPos()
 199         {
 200                 return m_nocheat_dig_pos;
 201         }
 202         float getNoCheatDigTime()
 203         {
 204                 return m_nocheat_dig_time;
 205         }
 206         void noCheatDigEnd()
 207         {
 208                 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
 209         }
 210
 211         // Other
 212
 213         void updatePrivileges(const std::set<std::string> &privs,
 214                         bool is_singleplayer)
 215         {
 216                 m_privs = privs;
 217                 m_is_singleplayer = is_singleplayer;
 218         }
 219
 220 private:
 221         std::string getPropertyPacket();
 222
 223         Player *m_player;
 224         u16 m_peer_id;
 225         Inventory *m_inventory;
 226
 227         // Cheat prevention
 228         v3f m_last_good_position;
 229         float m_last_good_position_age;
 230         float m_time_from_last_punch;
 231         v3s16 m_nocheat_dig_pos;
 232         float m_nocheat_dig_time;
 233
 234         int m_wield_index;
 235         bool m_position_not_sent;
 236         ItemGroupList m_armor_groups;
 237         bool m_armor_groups_sent;
 238         bool m_properties_sent;
 239         struct ObjectProperties m_prop;
 240         // Cached privileges for enforcement
 241         std::set<std::string> m_privs;
 242         bool m_is_singleplayer;
 243
 244 public:
 245         // Some flags used by Server
 246         bool m_teleported;
 247         bool m_inventory_not_sent;
 248         bool m_hp_not_sent;
 249         bool m_wielded_item_not_sent;
 250 };
 251
 252 #endif
 253