X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fserverobject.h;h=9884eb0a1e3aaf08bad5001eddc6aade8325fddf;hb=38abc91802ec12996d4fbb1e2f0ba4365d86b545;hp=76f7d01d678b8159b783eacc93f31b224210e049;hpb=7aa2d4d109cf8a92582a271d505f20a0f348f5a3;p=minetest.git diff --git a/src/serverobject.h b/src/serverobject.h index 76f7d01d6..9884eb0a1 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" /* @@ -40,40 +42,10 @@ Some planning */ -#if 0 -class IntervalLimiter -{ -public: - IntervalLimiter(): - m_accumulator(0) - { - } - /* - dtime: time from last call to this method - wanted_interval: interval wanted - return value: - true: action should be skipped - false: action should be done and dtime has been set - */ - bool step(float &dtime, float wanted_interval) - { - accumulator += dtime; - if(accumulator < wanted_interval) - { - dtime = 0; - return true; - } - accumulator -= wanted-interval; - dtime = wanted_interval; - return false; - } -protected: - float m_accumulator; -}; -#endif - class ServerEnvironment; -class InventoryItem; +struct ItemStack; +struct ToolCapabilities; +struct ObjectProperties; class ServerActiveObject : public ActiveObject { @@ -82,24 +54,48 @@ 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 ActiveObjectType 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; } + // Create a certain type of ServerActiveObject - static ServerActiveObject* create(u8 type, + static ServerActiveObject* create(ActiveObjectType type, ServerEnvironment *env, u16 id, v3f pos, const std::string &data); - + /* 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(const 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 std::string getDescription(){return "SAO";} + /* Step object in time. Messages added to messages are sent to client over network. @@ -110,30 +106,105 @@ 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 ""; + } + /* + Return false in here to never save and instead remove object + on unload. getStaticData() will not be called in that case. + */ + 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 ItemGroupList getArmorGroups() + { return ItemGroupList(); } + 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, bool frame_loop) + {} + virtual void getAnimation(v2f *frames, float *frame_speed, float *frame_blend, bool *frame_loop) + {} + virtual void setBonePosition(const std::string &bone, v3f position, v3f rotation) + {} + virtual void getBonePosition(const std::string &bone, v3f *position, v3f *lotation) + {} + virtual void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation) + {} + virtual void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation) + {} + virtual void addAttachmentChild(int child_id) + {} + virtual void removeAttachmentChild(int child_id) + {} + virtual UNORDERED_SET getAttachmentChildIds() + { return UNORDERED_SET(); } + 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); + inline void attachParticleSpawner(u32 id) + { + m_attached_particle_spawners.insert(id); + } + inline void detachParticleSpawner(u32 id) + { + m_attached_particle_spawners.erase(id); + } + + /* - Item that the player gets when this object is picked up. - If NULL, object cannot be picked up. + 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 InventoryItem* createPickedUpItem(){return NULL;} - - // 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. @@ -144,7 +215,18 @@ class ServerActiveObject : public ActiveObject - This can be set to true by anything else too. */ 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 */ @@ -154,80 +236,26 @@ class ServerActiveObject : public ActiveObject a copy of the static data resides. */ v3s16 m_static_block; - + + /* + Queue of messages to be sent to the client + */ + std::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); ServerEnvironment *m_env; v3f m_base_position; + UNORDERED_SET m_attached_particle_spawners; 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; -}; - -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: - 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; + static std::map m_types; }; #endif