/* Minetest Copyright (C) 2010-2013 celeron55, Perttu Ahola This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #pragma once #include "network/networkprotocol.h" #include "util/numeric.h" #include "serverobject.h" #include "itemgroup.h" #include "object_properties.h" #include "constants.h" class UnitSAO: public ServerActiveObject { public: UnitSAO(ServerEnvironment *env, v3f pos); virtual ~UnitSAO() = default; void setRotation(v3f rotation) { m_rotation = rotation; } const v3f &getRotation() const { return m_rotation; } v3f getRadRotation() { return m_rotation * core::DEGTORAD; } // Deprecated f32 getRadYawDep() const { return (m_rotation.Y + 90.) * core::DEGTORAD; } u16 getHP() const { return m_hp; } // Use a function, if isDead can be defined by other conditions bool isDead() const { return m_hp == 0; } inline bool isAttached() const { return getParent(); } inline bool isImmortal() const { return itemgroup_get(getArmorGroups(), "immortal"); } void setArmorGroups(const ItemGroupList &armor_groups); const ItemGroupList &getArmorGroups() const; void setAnimation(v2f frame_range, float frame_speed, float frame_blend, bool frame_loop); void getAnimation(v2f *frame_range, float *frame_speed, float *frame_blend, bool *frame_loop); void setAnimationSpeed(float frame_speed); void setBonePosition(const std::string &bone, v3f position, v3f rotation); void getBonePosition(const std::string &bone, v3f *position, v3f *rotation); void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation); void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation) const; void clearChildAttachments(); void clearParentAttachment(); void addAttachmentChild(int child_id); void removeAttachmentChild(int child_id); const std::unordered_set &getAttachmentChildIds() const; ServerActiveObject *getParent() const; ObjectProperties* accessObjectProperties(); void notifyObjectPropertiesModified(); protected: u16 m_hp = 1; v3f m_rotation; bool m_properties_sent = true; ObjectProperties m_prop; ItemGroupList m_armor_groups; bool m_armor_groups_sent = false; v2f m_animation_range; float m_animation_speed = 0.0f; float m_animation_blend = 0.0f; bool m_animation_loop = true; bool m_animation_sent = false; bool m_animation_speed_sent = false; // Stores position and rotation for each bone name std::unordered_map> m_bone_position; bool m_bone_position_sent = false; int m_attachment_parent_id = 0; std::unordered_set m_attachment_child_ids; std::string m_attachment_bone = ""; v3f m_attachment_position; v3f m_attachment_rotation; bool m_attachment_sent = false; private: void onAttach(int parent_id); void onDetach(int parent_id); }; /* LuaEntitySAO needs some internals exposed. */ class LuaEntitySAO : public UnitSAO { public: LuaEntitySAO(ServerEnvironment *env, v3f pos, const std::string &name, const std::string &state); ~LuaEntitySAO(); ActiveObjectType getType() const { return ACTIVEOBJECT_TYPE_LUAENTITY; } ActiveObjectType getSendType() const { return ACTIVEOBJECT_TYPE_GENERIC; } virtual void addedToEnvironment(u32 dtime_s); static ServerActiveObject* create(ServerEnvironment *env, v3f pos, const std::string &data); void step(float dtime, bool send_recommended); std::string getClientInitializationData(u16 protocol_version); bool isStaticAllowed() const { return m_prop.static_save; } void getStaticData(std::string *result) const; u16 punch(v3f dir, const ToolCapabilities *toolcap = nullptr, ServerActiveObject *puncher = nullptr, float time_from_last_punch = 1000000.0f); void rightClick(ServerActiveObject *clicker); void setPos(const v3f &pos); void moveTo(v3f pos, bool continuous); float getMinimumSavedMovement(); std::string getDescription(); void setHP(s32 hp, const PlayerHPChangeReason &reason); u16 getHP() const; /* LuaEntitySAO-specific */ void setVelocity(v3f velocity); void addVelocity(v3f velocity) { m_velocity += velocity; } v3f getVelocity(); void setAcceleration(v3f acceleration); v3f getAcceleration(); void setTextureMod(const std::string &mod); std::string getTextureMod() const; void setSprite(v2s16 p, int num_frames, float framelength, bool select_horiz_by_yawpitch); std::string getName(); bool getCollisionBox(aabb3f *toset) const; bool getSelectionBox(aabb3f *toset) const; bool collideWithObjects() const; private: std::string getPropertyPacket(); void sendPosition(bool do_interpolate, bool is_movement_end); std::string m_init_name; std::string m_init_state; bool m_registered = false; v3f m_velocity; v3f m_acceleration; v3f m_last_sent_position; v3f m_last_sent_velocity; v3f m_last_sent_rotation; float m_last_sent_position_timer = 0.0f; float m_last_sent_move_precision = 0.0f; std::string m_current_texture_modifier = ""; }; /* PlayerSAO needs some internals exposed. */ class LagPool { float m_pool = 15.0f; float m_max = 15.0f; public: LagPool() = default; void setMax(float new_max) { m_max = new_max; if(m_pool > new_max) m_pool = new_max; } void add(float dtime) { m_pool -= dtime; if(m_pool < 0) m_pool = 0; } void empty() { m_pool = m_max; } bool grab(float dtime) { if(dtime <= 0) return true; if(m_pool + dtime > m_max) return false; m_pool += dtime; return true; } }; class RemotePlayer; class PlayerSAO : public UnitSAO { public: PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, session_t peer_id_, bool is_singleplayer); ActiveObjectType getType() const { return ACTIVEOBJECT_TYPE_PLAYER; } ActiveObjectType getSendType() const { return ACTIVEOBJECT_TYPE_GENERIC; } std::string getDescription(); /* Active object <-> environment interface */ void addedToEnvironment(u32 dtime_s); void removingFromEnvironment(); bool isStaticAllowed() const { return false; } std::string getClientInitializationData(u16 protocol_version); void getStaticData(std::string *result) const; void step(float dtime, bool send_recommended); void setBasePosition(const v3f &position); void setPos(const v3f &pos); void moveTo(v3f pos, bool continuous); void setPlayerYaw(const float yaw); // Data should not be sent at player initialization void setPlayerYawAndSend(const float yaw); void setLookPitch(const float pitch); // Data should not be sent at player initialization void setLookPitchAndSend(const float pitch); f32 getLookPitch() const { return m_pitch; } f32 getRadLookPitch() const { return m_pitch * core::DEGTORAD; } // Deprecated f32 getRadLookPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; } void setFov(const float pitch); f32 getFov() const { return m_fov; } void setWantedRange(const s16 range); s16 getWantedRange() const { return m_wanted_range; } /* Interaction interface */ u16 punch(v3f dir, const ToolCapabilities *toolcap, ServerActiveObject *puncher, float time_from_last_punch); void rightClick(ServerActiveObject *clicker) {} void setHP(s32 hp, const PlayerHPChangeReason &reason); void setHPRaw(u16 hp) { m_hp = hp; } s16 readDamage(); u16 getBreath() const { return m_breath; } void setBreath(const u16 breath, bool send = true); /* Inventory interface */ Inventory *getInventory() const; InventoryLocation getInventoryLocation() const; void setInventoryModified() {} std::string getWieldList() const { return "main"; } u16 getWieldIndex() const; ItemStack getWieldedItem(ItemStack *selected, ItemStack *hand = nullptr) const; bool setWieldedItem(const ItemStack &item); /* PlayerSAO-specific */ void disconnected(); RemotePlayer *getPlayer() { return m_player; } session_t getPeerID() const { return m_peer_id; } // Cheat prevention v3f getLastGoodPosition() const { return m_last_good_position; } float resetTimeFromLastPunch() { float r = m_time_from_last_punch; m_time_from_last_punch = 0.0; return r; } void noCheatDigStart(const v3s16 &p) { m_nocheat_dig_pos = p; m_nocheat_dig_time = 0; } v3s16 getNoCheatDigPos() { return m_nocheat_dig_pos; } float getNoCheatDigTime() { return m_nocheat_dig_time; } void noCheatDigEnd() { m_nocheat_dig_pos = v3s16(32767, 32767, 32767); } LagPool& getDigPool() { return m_dig_pool; } void setMaxSpeedOverride(const v3f &vel); // Returns true if cheated bool checkMovementCheat(); // Other void updatePrivileges(const std::set &privs, bool is_singleplayer) { m_privs = privs; m_is_singleplayer = is_singleplayer; } bool getCollisionBox(aabb3f *toset) const; bool getSelectionBox(aabb3f *toset) const; bool collideWithObjects() const { return true; } void finalize(RemotePlayer *player, const std::set &privs); v3f getEyePosition() const { return m_base_position + getEyeOffset(); } v3f getEyeOffset() const; float getZoomFOV() const; inline Metadata &getMeta() { return m_meta; } private: std::string getPropertyPacket(); void unlinkPlayerSessionAndSave(); RemotePlayer *m_player = nullptr; session_t m_peer_id = 0; // Cheat prevention LagPool m_dig_pool; LagPool m_move_pool; v3f m_last_good_position; float m_time_from_last_teleport = 0.0f; float m_time_from_last_punch = 0.0f; v3s16 m_nocheat_dig_pos = v3s16(32767, 32767, 32767); float m_nocheat_dig_time = 0.0f; float m_max_speed_override_time = 0.0f; v3f m_max_speed_override = v3f(0.0f, 0.0f, 0.0f); // Timers IntervalLimiter m_breathing_interval; IntervalLimiter m_drowning_interval; IntervalLimiter m_node_hurt_interval; bool m_position_not_sent = false; // Cached privileges for enforcement std::set m_privs; bool m_is_singleplayer; u16 m_breath = PLAYER_MAX_BREATH_DEFAULT; f32 m_pitch = 0.0f; f32 m_fov = 0.0f; s16 m_wanted_range = 0.0f; Metadata m_meta; public: float m_physics_override_speed = 1.0f; float m_physics_override_jump = 1.0f; float m_physics_override_gravity = 1.0f; bool m_physics_override_sneak = true; bool m_physics_override_sneak_glitch = false; bool m_physics_override_new_move = true; bool m_physics_override_sent = false; }; struct PlayerHPChangeReason { enum Type : u8 { SET_HP, PLAYER_PUNCH, FALL, NODE_DAMAGE, DROWNING, RESPAWN }; Type type = SET_HP; bool from_mod = false; int lua_reference = -1; // For PLAYER_PUNCH ServerActiveObject *object = nullptr; // For NODE_DAMAGE std::string node; inline bool hasLuaReference() const { return lua_reference >= 0; } bool setTypeFromString(const std::string &typestr) { if (typestr == "set_hp") type = SET_HP; else if (typestr == "punch") type = PLAYER_PUNCH; else if (typestr == "fall") type = FALL; else if (typestr == "node_damage") type = NODE_DAMAGE; else if (typestr == "drown") type = DROWNING; else if (typestr == "respawn") type = RESPAWN; else return false; return true; } std::string getTypeAsString() const { switch (type) { case PlayerHPChangeReason::SET_HP: return "set_hp"; case PlayerHPChangeReason::PLAYER_PUNCH: return "punch"; case PlayerHPChangeReason::FALL: return "fall"; case PlayerHPChangeReason::NODE_DAMAGE: return "node_damage"; case PlayerHPChangeReason::DROWNING: return "drown"; case PlayerHPChangeReason::RESPAWN: return "respawn"; default: return "?"; } } PlayerHPChangeReason(Type type): type(type) {} PlayerHPChangeReason(Type type, ServerActiveObject *object): type(type), object(object) {} PlayerHPChangeReason(Type type, std::string node): type(type), node(node) {} };