X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fserverobject.h;h=48689fcb49761c6257f0babf6a0e09869d2ccea8;hb=37f771a95bd54e2072f07783df142da4a91e7bff;hp=cd98ba0aa3e232197c6e5596def37b1aede5a1f4;hpb=38944467d31bbfa8a98008962f147cbc3c73f507;p=oweals%2Fminetest.git diff --git a/src/serverobject.h b/src/serverobject.h index cd98ba0aa..48689fcb4 100644 --- a/src/serverobject.h +++ b/src/serverobject.h @@ -1,28 +1,30 @@ /* -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. */ -#ifndef SERVEROBJECT_HEADER -#define SERVEROBJECT_HEADER +#pragma once -#include "irrlichttypes.h" +#include +#include "irrlichttypes_bloated.h" #include "activeobject.h" -#include "utility.h" +#include "inventorymanager.h" +#include "itemgroup.h" +#include "util/container.h" /* @@ -41,8 +43,10 @@ Some planning */ class ServerEnvironment; -class InventoryItem; -class Player; +struct ItemStack; +struct ToolCapabilities; +struct ObjectProperties; +struct PlayerHPChangeReason; class ServerActiveObject : public ActiveObject { @@ -52,30 +56,46 @@ public: Prototypes are used that way. */ ServerActiveObject(ServerEnvironment *env, v3f pos); - virtual ~ServerActiveObject(); + virtual ~ServerActiveObject() = default; + + 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; } - virtual void addedToEnvironment(u16 id); - // 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) - { setBasePosition(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) - { setBasePosition(pos); } + { 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. @@ -88,84 +108,143 @@ public: 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(){return "";} - - /* - Item that the player gets when this object is picked up. - If NULL, object cannot be picked up. - */ - virtual InventoryItem* createPickedUpItem(){return NULL;} - + virtual void getStaticData(std::string *result) const + { + assert(isStaticAllowed()); + *result = ""; + } /* - If the object doesn't return an item, this will be called. - Return value is tool wear. + Return false in here to never save and instead remove object + on unload. getStaticData() will not be called in that case. */ - virtual u16 punch(const std::string &toolname, v3f dir, - const std::string &playername) - {return 0;} + virtual bool isStaticAllowed() const + {return true;} + + // Returns tool wear + virtual u16 punch(v3f dir, + const ToolCapabilities *toolcap = nullptr, + ServerActiveObject *puncher = nullptr, + float time_from_last_punch = 1000000.0f) + { return 0; } + virtual void rightClick(ServerActiveObject *clicker) + {} + virtual void setHP(s32 hp, const PlayerHPChangeReason &reason) + {} + virtual u16 getHP() const + { return 0; } + + virtual void setArmorGroups(const ItemGroupList &armor_groups) + {} + virtual const ItemGroupList &getArmorGroups() const + { static 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 const std::unordered_set &getAttachmentChildIds() const + { static std::unordered_set rv; return rv; } + virtual ServerActiveObject *getParent() const { return nullptr; } + virtual ObjectProperties* accessObjectProperties() + { return NULL; } + virtual void notifyObjectPropertiesModified() + {} + + // Inventory and wielded item + virtual Inventory *getInventory() const + { return NULL; } + virtual InventoryLocation getInventoryLocation() const + { return InventoryLocation(); } + virtual void setInventoryModified() + {} + virtual std::string getWieldList() const + { return ""; } + virtual u16 getWieldIndex() const + { return 0; } + virtual ItemStack getWieldedItem(ItemStack *selected, + ItemStack *hand = nullptr) 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); + } - /* - */ - virtual void rightClick(Player *player){} - virtual bool isPeaceful(){return true;} - /* 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 a block 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 - The environment checks this periodically. If this is true and also - m_known_by_count is true, + If this is set alongside with m_pending_removal, removal takes + priority. + */ + bool m_pending_deactivation = false; + + /* + 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 m_messages_out; - + std::queue m_messages_out; + protected: + virtual void onAttach(int parent_id) {} + virtual void onDetach(int parent_id) {} + // Used for creating objects based on type typedef ServerActiveObject* (*Factory) (ServerEnvironment *env, v3f pos, @@ -174,11 +253,9 @@ protected: ServerEnvironment *m_env; v3f m_base_position; + std::unordered_set m_attached_particle_spawners; private: // Used for creating objects based on type - static core::map m_types; + static std::map m_types; }; - -#endif -