]> git.lizzy.rs Git - minetest.git/blobdiff - src/serverobject.h
Move files to subdirectories (#6599)
[minetest.git] / src / serverobject.h
index a0886ed1e4221d4f5da0e6deca967153786b2511..304281093cc20302b4cd414803508fd5f6763746 100644 (file)
@@ -1,6 +1,6 @@
 /*
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 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
@@ -17,9 +17,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef SERVEROBJECT_HEADER
-#define SERVEROBJECT_HEADER
+#pragma once
 
+#include <unordered_set>
 #include "irrlichttypes_bloated.h"
 #include "activeobject.h"
 #include "inventorymanager.h"
@@ -44,7 +44,6 @@ Some planning
 
 class ServerEnvironment;
 struct ItemStack;
-class Player;
 struct ToolCapabilities;
 struct ObjectProperties;
 
@@ -56,9 +55,9 @@ class ServerActiveObject : public ActiveObject
                Prototypes are used that way.
        */
        ServerActiveObject(ServerEnvironment *env, v3f pos);
-       virtual ~ServerActiveObject();
+       virtual ~ServerActiveObject() = default;
 
-       virtual u8 getSendType() const
+       virtual ActiveObjectType getSendType() const
        { return getType(); }
 
        // Called after id has been set and has been inserted in environment
@@ -70,26 +69,23 @@ class ServerActiveObject : public ActiveObject
        virtual bool environmentDeletes() const
        { return true; }
 
-       virtual bool unlimitedTransferDistance() const
-       { return false; }
-       
        // 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; }
+       v3f getBasePosition() const { 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)
+
+       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)
@@ -97,11 +93,9 @@ class ServerActiveObject : public ActiveObject
        // 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.
                Messages added to messages are sent to client over network.
@@ -113,22 +107,22 @@ class ServerActiveObject : public ActiveObject
                        packet.
        */
        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()
+       virtual void getStaticData(std::string *result) const
        {
                assert(isStaticAllowed());
-               return "";
+               *result = "";
        }
        /*
                Return false in here to never save and instead remove object
@@ -136,7 +130,7 @@ class ServerActiveObject : public ActiveObject
        */
        virtual bool isStaticAllowed() const
        {return true;}
-       
+
        // Returns tool wear
        virtual int punch(v3f dir,
                        const ToolCapabilities *toolcap=NULL,
@@ -152,12 +146,30 @@ class ServerActiveObject : public ActiveObject
 
        virtual void setArmorGroups(const ItemGroupList &armor_groups)
        {}
-       virtual void setAnimations(v2f frames, float frame_speed, float frame_blend)
+       virtual const ItemGroupList &getArmorGroups()
+       { static const ItemGroupList rv; return rv; }
+       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 setAnimationSpeed(float frame_speed)
+       {}
+       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 setBonePosRot(std::string bone, v3f position, v3f rotation)
+       virtual void addAttachmentChild(int child_id)
        {}
-       virtual void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation)
+       virtual void removeAttachmentChild(int child_id)
        {}
+       virtual const std::unordered_set<int> &getAttachmentChildIds()
+       { static const std::unordered_set<int> rv; return rv; }
        virtual ObjectProperties* accessObjectProperties()
        { return NULL; }
        virtual void notifyObjectPropertiesModified()
@@ -178,51 +190,64 @@ class ServerActiveObject : public ActiveObject
        { 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);
+       }
+
 
        /*
                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.
        */
-       u16 m_known_by_count;
+       u16 m_known_by_count = 0;
 
        /*
                - Whether this object is to be removed when nobody knows about
                  it anymore.
                - Removal is delayed to preserve the id for the time during which
                  it could be confused to some other object by some client.
-               - This is set to true by the step() method when the object wants
-                 to be deleted.
-               - This can be set to true by anything else too.
+               - This is usually set to true by the step() method when the object wants
+                 to be deleted but can be set by anything else too.
        */
-       bool m_removed;
-       
+       bool m_pending_removal = false;
+
        /*
-               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.
+               Same purpose as m_pending_removal but for deactivation.
+               deactvation = save static data in block, remove active object
+
+               If this is set alongside with m_pending_removal, removal takes
+               priority.
+       */
+       bool m_pending_deactivation = false;
 
-               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.
+       /*
+               A getter that unifies the above to answer the question:
+               "Can the environment still interact with this object?"
        */
-       bool m_pending_deactivation;
-       
+       inline bool isGone() const
+       { return m_pending_removal || m_pending_deactivation; }
+
        /*
                Whether the object's static data has been stored to a block
        */
-       bool m_static_exists;
+       bool m_static_exists = false;
        /*
                The block from which the object was loaded from, and in which
                a copy of the static data resides.
        */
-       v3s16 m_static_block;
-       
+       v3s16 m_static_block = v3s16(1337,1337,1337);
+
        /*
                Queue of messages to be sent to the client
        */
-       Queue<ActiveObjectMessage> m_messages_out;
-       
+       std::queue<ActiveObjectMessage> m_messages_out;
+
 protected:
        // Used for creating objects based on type
        typedef ServerActiveObject* (*Factory)
@@ -232,11 +257,9 @@ class ServerActiveObject : public ActiveObject
 
        ServerEnvironment *m_env;
        v3f m_base_position;
+       std::unordered_set<u32> m_attached_particle_spawners;
 
 private:
        // Used for creating objects based on type
-       static core::map<u16, Factory> m_types;
+       static std::map<u16, Factory> m_types;
 };
-
-#endif
-