X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fserverobject.h;h=13a075a2575b52dd59ce3f99ca9caace8d8c6de8;hb=b8ba6318d6ed9edd59455674d39ff1d5018393df;hp=71199475e4936ca28a2ae11a71b75cfa8a0cfd8d;hpb=c638442e78b953556e7dadd4c0c34cb0c719bbc8;p=minetest.git diff --git a/src/serverobject.h b/src/serverobject.h index 71199475e..13a075a25 100644 --- a/src/serverobject.h +++ b/src/serverobject.h @@ -1,18 +1,18 @@ /* -Minetest-c55 -Copyright (C) 2010-2011 celeron55, Perttu Ahola +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 General Public License as published by -the Free Software Foundation; either version 2 of the License, or +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 General Public License for more details. +GNU Lesser General Public License for more details. -You should have received a copy of the GNU General Public License along +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. */ @@ -20,9 +20,11 @@ with this program; if not, write to the Free Software Foundation, Inc., #ifndef SERVEROBJECT_HEADER #define SERVEROBJECT_HEADER -#include "common_irrlicht.h" +#include "irrlichttypes_bloated.h" #include "activeobject.h" -#include "utility.h" +#include "inventorymanager.h" +#include "itemgroup.h" +#include "util/container.h" /* @@ -41,7 +43,10 @@ Some planning */ class ServerEnvironment; -class InventoryItem; +struct ItemStack; +class Player; +struct ToolCapabilities; +struct ObjectProperties; class ServerActiveObject : public ActiveObject { @@ -50,9 +55,24 @@ class ServerActiveObject : public ActiveObject NOTE: m_env can be NULL, but step() isn't called if it is. Prototypes are used that way. */ - ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos); + ServerActiveObject(ServerEnvironment *env, v3f pos); virtual ~ServerActiveObject(); + virtual u8 getSendType() const + { return getType(); } + + // Called after id has been set and has been inserted in environment + virtual void addedToEnvironment(u32 dtime_s){}; + // Called before removing from environment + virtual void removingFromEnvironment(){}; + // Returns true if object's deletion is the job of the + // environment + virtual bool environmentDeletes() const + { return true; } + + virtual bool unlimitedTransferDistance() const + { return false; } + // Create a certain type of ServerActiveObject static ServerActiveObject* create(u8 type, ServerEnvironment *env, u16 id, v3f pos, @@ -61,12 +81,26 @@ class ServerActiveObject : public ActiveObject /* Some simple getters/setters */ - v3f getBasePosition() - {return m_base_position;} - void setBasePosition(v3f pos) - {m_base_position = pos;} - ServerEnvironment* getEnv() - {return m_env;} + v3f getBasePosition(){ return m_base_position; } + void setBasePosition(v3f pos){ m_base_position = pos; } + ServerEnvironment* getEnv(){ return m_env; } + + /* + Some more dynamic interface + */ + + virtual void setPos(v3f pos) + { setBasePosition(pos); } + // continuous: if true, object does not stop immediately at pos + virtual void moveTo(v3f pos, bool continuous) + { setBasePosition(pos); } + // If object has moved less than this and data has not changed, + // saving to disk may be omitted + virtual float getMinimumSavedMovement(); + + virtual bool isPeaceful(){return true;} + + virtual std::string getDescription(){return "SAO";} /* Step object in time. @@ -78,36 +112,82 @@ class ServerActiveObject : public ActiveObject same time so that the data can be combined in a single packet. */ - virtual void step(float dtime, Queue &messages, - bool send_recommended){} + virtual void step(float dtime, bool send_recommended){} /* The return value of this is passed to the client-side object when it is created */ - virtual std::string getClientInitializationData(){return "";} + virtual std::string getClientInitializationData(u16 protocol_version){return "";} /* The return value of this is passed to the server-side object when it is created (converted from static to active - actually the data is the static form) */ - virtual std::string getStaticData(){return "";} - + virtual std::string getStaticData() + { + assert(isStaticAllowed()); + return ""; + } /* - Item that the player gets when this object is picked up. - If NULL, object cannot be picked up. + Return false in here to never save and instead remove object + on unload. getStaticData() will not be called in that case. */ - virtual InventoryItem* createPickedUpItem(){return NULL;} + virtual bool isStaticAllowed() const + {return true;} + // Returns tool wear + virtual int punch(v3f dir, + const ToolCapabilities *toolcap=NULL, + ServerActiveObject *puncher=NULL, + float time_from_last_punch=1000000) + { return 0; } + virtual void rightClick(ServerActiveObject *clicker) + {} + virtual void setHP(s16 hp) + {} + virtual s16 getHP() const + { return 0; } + + virtual void setArmorGroups(const ItemGroupList &armor_groups) + {} + virtual void setPhysicsOverride(float physics_override_speed, float physics_override_jump, float physics_override_gravity) + {} + virtual void setAnimation(v2f frames, float frame_speed, float frame_blend) + {} + virtual void setBonePosition(std::string bone, v3f position, v3f rotation) + {} + virtual void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation) + {} + virtual ObjectProperties* accessObjectProperties() + { return NULL; } + virtual void notifyObjectPropertiesModified() + {} + + // Inventory and wielded item + virtual Inventory* getInventory() + { return NULL; } + virtual const Inventory* getInventory() const + { return NULL; } + virtual InventoryLocation getInventoryLocation() const + { return InventoryLocation(); } + virtual void setInventoryModified() + {} + virtual std::string getWieldList() const + { return ""; } + virtual int getWieldIndex() const + { return 0; } + virtual ItemStack getWieldedItem() const; + virtual bool setWieldedItem(const ItemStack &item); + /* - If the object doesn't return an item, this will be called. - Return value is tool wear. + Number of players which know about this object. Object won't be + deleted until this is 0 to keep the id preserved for the right + object. */ - virtual u16 punch(const std::string &toolname){return 0;} - - // Number of players which know about this object u16 m_known_by_count; + /* - Whether this object is to be removed when nobody knows about it anymore. @@ -119,6 +199,17 @@ class ServerActiveObject : public ActiveObject */ bool m_removed; + /* + This is set to true when an object should be removed from the active + object list but couldn't be removed because the id has to be + reserved for some client. + + The environment checks this periodically. If this is true and also + m_known_by_count is true, object is deleted from the active object + list. + */ + bool m_pending_deactivation; + /* Whether the object's static data has been stored to a block */ @@ -129,10 +220,15 @@ class ServerActiveObject : public ActiveObject */ v3s16 m_static_block; + /* + Queue of messages to be sent to the client + */ + Queue m_messages_out; + protected: // Used for creating objects based on type typedef ServerActiveObject* (*Factory) - (ServerEnvironment *env, u16 id, v3f pos, + (ServerEnvironment *env, v3f pos, const std::string &data); static void registerType(u16 type, Factory f); @@ -141,98 +237,7 @@ class ServerActiveObject : public ActiveObject private: // Used for creating objects based on type - static core::map m_types; -}; - -class TestSAO : public ServerActiveObject -{ -public: - TestSAO(ServerEnvironment *env, u16 id, v3f pos); - u8 getType() const - {return ACTIVEOBJECT_TYPE_TEST;} - static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos, - const std::string &data); - void step(float dtime, Queue &messages, - bool send_recommended); -private: - float m_timer1; - float m_age; -}; - -class ItemSAO : public ServerActiveObject -{ -public: - ItemSAO(ServerEnvironment *env, u16 id, v3f pos, - const std::string inventorystring); - u8 getType() const - {return ACTIVEOBJECT_TYPE_ITEM;} - static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos, - const std::string &data); - void step(float dtime, Queue &messages, - bool send_recommended); - std::string getClientInitializationData(); - std::string getStaticData(); - InventoryItem* createInventoryItem(); - InventoryItem* createPickedUpItem(){return createInventoryItem();} -private: - std::string m_inventorystring; - v3f m_speed_f; - v3f m_last_sent_position; - IntervalLimiter m_move_interval; -}; - -class RatSAO : public ServerActiveObject -{ -public: - RatSAO(ServerEnvironment *env, u16 id, v3f pos); - u8 getType() const - {return ACTIVEOBJECT_TYPE_RAT;} - static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos, - const std::string &data); - void step(float dtime, Queue &messages, - bool send_recommended); - std::string getClientInitializationData(); - std::string getStaticData(); - InventoryItem* createPickedUpItem(); -private: - bool m_is_active; - IntervalLimiter m_inactive_interval; - v3f m_speed_f; - v3f m_oldpos; - v3f m_last_sent_position; - float m_yaw; - float m_counter1; - float m_counter2; - float m_age; - bool m_touching_ground; -}; - -class Oerkki1SAO : public ServerActiveObject -{ -public: - Oerkki1SAO(ServerEnvironment *env, u16 id, v3f pos); - u8 getType() const - {return ACTIVEOBJECT_TYPE_OERKKI1;} - static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos, - const std::string &data); - void step(float dtime, Queue &messages, - bool send_recommended); - std::string getClientInitializationData(); - std::string getStaticData(); - InventoryItem* createPickedUpItem(){return NULL;} - u16 punch(const std::string &toolname); -private: - bool m_is_active; - IntervalLimiter m_inactive_interval; - v3f m_speed_f; - v3f m_oldpos; - v3f m_last_sent_position; - float m_yaw; - float m_counter1; - float m_counter2; - float m_age; - bool m_touching_ground; - u8 m_hp; + static std::map m_types; }; #endif