/*MinetestCopyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>This program is free software; you can redistribute it and/or modifyit under the terms of the GNU Lesser General Public License as published bythe 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU Lesser General Public License for more details.You should have received a copy of the GNU Lesser General Public License alongwith this program; if not, write to the Free Software Foundation, Inc.,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.*/#pragma once#include <unordered_set>#include"irrlichttypes_bloated.h"#include"activeobject.h"#include"inventorymanager.h"#include"itemgroup.h"#include"util/container.h"/*Some planning-------------* Server environment adds an active object, which gets the id 1* The active object list is scanned for each client once in a while, and it finds out what objects have been added that are not known by the client yet. This scan is initiated by the Server class and the result ends up directly to the server.* A network packet is created with the info and sent to the client.* Environment converts objects to static data and static data to objects, based on how close players are to them.*/class ServerEnvironment;struct ItemStack;struct ToolCapabilities;struct ObjectProperties;struct PlayerHPChangeReason;class ServerActiveObject :public ActiveObject
{public:/* NOTE: m_env can be NULL, but step() isn't called if it is. Prototypes are used that way. */ServerActiveObject(ServerEnvironment *env, v3f pos);virtual~ServerActiveObject() =default;virtual ActiveObjectType getSendType()const{returngetType(); }// Called after id has been set and has been inserted in environmentvirtualvoidaddedToEnvironment(u32 dtime_s){};// Called before removing from environmentvirtualvoidremovingFromEnvironment(){};// Returns true if object's deletion is the job of the// environmentvirtualboolenvironmentDeletes()const{return true; }// Safely mark the object for removal or deactivationvoidmarkForRemoval();voidmarkForDeactivation();// Create a certain type of ServerActiveObjectstatic ServerActiveObject*create(ActiveObjectType type,
ServerEnvironment *env, u16 id, v3f pos,conststd::string &data);/* Some simple getters/setters */
v3f getBasePosition()const{return m_base_position; }voidsetBasePosition(v3f pos){ m_base_position = pos; }
ServerEnvironment*getEnv(){return m_env; }/* Some more dynamic interface */virtualvoidsetPos(const v3f &pos){setBasePosition(pos); }// continuous: if true, object does not stop immediately at posvirtualvoidmoveTo(v3f pos,bool continuous){setBasePosition(pos); }// If object has moved less than this and data has not changed,// saving to disk may be omittedvirtualfloatgetMinimumSavedMovement();virtual std::string getDescription(){return"SAO";}/* Step object in time. Messages added to messages are sent to client over network. send_recommended: True at around 5-10 times a second, same for all objects. This is used to let objects send most of the data at the same time so that the data can be combined in a single packet. */virtualvoidstep(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(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) */virtualvoidgetStaticData(std::string *result)const{assert(isStaticAllowed());*result ="";}/* Return false in here to never save and instead remove object on unload. getStaticData() will not be called in that case. */virtualboolisStaticAllowed()const{return true;}/* Return false here to never unload the object. isStaticAllowed && shouldUnload -> unload when out of active block range !isStaticAllowed && shouldUnload -> unload when block is unloaded */virtualboolshouldUnload()const{return true; }// Returns tool wearvirtual u16 punch(v3f dir,const ToolCapabilities *toolcap =nullptr,
ServerActiveObject *puncher =nullptr,float time_from_last_punch =1000000.0f){return0; }virtualvoidrightClick(ServerActiveObject *clicker){}virtualvoidsetHP(s32 hp,const PlayerHPChangeReason &reason){}virtual u16 getHP()const{return0; }virtualvoidsetArmorGroups(const ItemGroupList &armor_groups){}virtualconst ItemGroupList &getArmorGroups()const{static ItemGroupList rv;return rv; }virtualvoidsetAnimation(v2f frames,float frame_speed,float frame_blend,bool frame_loop){}virtualvoidgetAnimation(v2f *frames,float*frame_speed,float*frame_blend,bool*frame_loop){}virtualvoidsetAnimationSpeed(float frame_speed){}virtualvoidsetBonePosition(conststd::string &bone, v3f position, v3f rotation){}virtualvoidgetBonePosition(conststd::string &bone, v3f *position, v3f *lotation){}virtualconststd::unordered_set<int> &getAttachmentChildIds()const{staticstd::unordered_set<int> rv;return rv; }virtual ServerActiveObject *getParent()const{returnnullptr; }virtual ObjectProperties*accessObjectProperties(){return NULL; }virtualvoidnotifyObjectPropertiesModified(){}// Inventory and wielded itemvirtual Inventory *getInventory()const{return NULL; }virtual InventoryLocation getInventoryLocation()const{returnInventoryLocation(); }virtualvoidsetInventoryModified(){}virtual std::string getWieldList()const{return""; }virtual u16 getWieldIndex()const{return0; }virtual ItemStack getWieldedItem(ItemStack *selected,
ItemStack *hand =nullptr)const;virtualboolsetWieldedItem(const ItemStack &item);inlinevoidattachParticleSpawner(u32 id){
m_attached_particle_spawners.insert(id);}inlinevoiddetachParticleSpawner(u32 id){
m_attached_particle_spawners.erase(id);}std::string generateUpdateInfantCommand(u16 infant_id, u16 protocol_version);voiddumpAOMessagesToQueue(std::queue<ActiveObjectMessage> &queue);/* 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 =0;/* A getter that unifies the above to answer the question: "Can the environment still interact with this object?" */inlineboolisGone()const{return m_pending_removal || m_pending_deactivation; }inlineboolisPendingRemoval()const{return m_pending_removal; }/* Whether the object's static data has been stored to a block */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(1337,1337,1337);protected:virtualvoidonMarkedForDeactivation() {}virtualvoidonMarkedForRemoval() {}virtualvoidonAttach(int parent_id) {}virtualvoidonDetach(int parent_id) {}
ServerEnvironment *m_env;
v3f m_base_position;std::unordered_set<u32> m_attached_particle_spawners;/* 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. Note: Do not assign this directly, use markForDeactivation() instead. */bool m_pending_deactivation =false;/* - 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 usually set to true by the step() method when the object wants to be deleted but can be set by anything else too. Note: Do not assign this directly, use markForRemoval() instead. */bool m_pending_removal =false;/* Queue of messages to be sent to the client */std::queue<ActiveObjectMessage> m_messages_out;};