2011-02-21 01:45:14 +03:00
|
|
|
/*
|
2013-02-24 21:40:43 +04:00
|
|
|
Minetest
|
2013-02-24 22:38:45 +04:00
|
|
|
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
2011-02-21 01:45:14 +03:00
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
2012-06-05 18:56:56 +04:00
|
|
|
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
|
2011-02-21 01:45:14 +03:00
|
|
|
(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
|
2012-06-05 18:56:56 +04:00
|
|
|
GNU Lesser General Public License for more details.
|
2011-02-21 01:45:14 +03:00
|
|
|
|
2012-06-05 18:56:56 +04:00
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
2011-02-21 01:45:14 +03:00
|
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
*/
|
|
|
|
|
2017-08-17 23:19:39 +03:00
|
|
|
#pragma once
|
2011-02-21 01:45:14 +03:00
|
|
|
|
2017-06-04 22:00:04 +03:00
|
|
|
#include <unordered_set>
|
2012-06-17 05:00:31 +04:00
|
|
|
#include "irrlichttypes_bloated.h"
|
2011-02-21 01:45:14 +03:00
|
|
|
#include "activeobject.h"
|
2012-01-12 09:10:39 +04:00
|
|
|
#include "inventorymanager.h"
|
2012-03-29 17:10:11 +04:00
|
|
|
#include "itemgroup.h"
|
2012-06-17 03:40:36 +04:00
|
|
|
#include "util/container.h"
|
2011-02-21 01:45:14 +03:00
|
|
|
|
|
|
|
/*
|
|
|
|
|
|
|
|
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
|
2011-04-10 13:34:12 +04:00
|
|
|
by the client yet. This scan is initiated by the Server class and
|
|
|
|
the result ends up directly to the server.
|
2011-02-21 01:45:14 +03:00
|
|
|
* A network packet is created with the info and sent to the client.
|
2011-04-10 13:34:12 +04:00
|
|
|
* Environment converts objects to static data and static data to
|
|
|
|
objects, based on how close players are to them.
|
2011-02-21 01:45:14 +03:00
|
|
|
|
|
|
|
*/
|
|
|
|
|
2011-02-21 17:10:36 +03:00
|
|
|
class ServerEnvironment;
|
2012-01-23 23:23:56 +04:00
|
|
|
struct ItemStack;
|
2012-03-04 23:08:03 +04:00
|
|
|
struct ToolCapabilities;
|
2012-03-30 14:26:40 +04:00
|
|
|
struct ObjectProperties;
|
2018-03-28 18:05:18 +03:00
|
|
|
struct PlayerHPChangeReason;
|
2011-02-21 17:10:36 +03:00
|
|
|
|
2011-02-21 01:45:14 +03:00
|
|
|
class ServerActiveObject : public ActiveObject
|
|
|
|
{
|
|
|
|
public:
|
2011-04-10 17:20:31 +04:00
|
|
|
/*
|
|
|
|
NOTE: m_env can be NULL, but step() isn't called if it is.
|
|
|
|
Prototypes are used that way.
|
|
|
|
*/
|
2011-11-11 21:33:17 +04:00
|
|
|
ServerActiveObject(ServerEnvironment *env, v3f pos);
|
2017-08-19 15:25:35 +03:00
|
|
|
virtual ~ServerActiveObject() = default;
|
2011-02-21 01:45:14 +03:00
|
|
|
|
2015-02-16 19:42:13 +03:00
|
|
|
virtual ActiveObjectType getSendType() const
|
2012-03-29 17:10:11 +04:00
|
|
|
{ return getType(); }
|
|
|
|
|
2011-12-01 15:22:33 +04:00
|
|
|
// Called after id has been set and has been inserted in environment
|
2012-09-09 18:12:29 +04:00
|
|
|
virtual void addedToEnvironment(u32 dtime_s){};
|
2011-12-01 15:22:33 +04:00
|
|
|
// Called before removing from environment
|
|
|
|
virtual void removingFromEnvironment(){};
|
2011-12-01 20:23:58 +04:00
|
|
|
// Returns true if object's deletion is the job of the
|
|
|
|
// environment
|
|
|
|
virtual bool environmentDeletes() const
|
|
|
|
{ return true; }
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-04-10 05:15:10 +04:00
|
|
|
// Create a certain type of ServerActiveObject
|
2015-02-17 13:37:55 +03:00
|
|
|
static ServerActiveObject* create(ActiveObjectType type,
|
2011-04-10 05:15:10 +04:00
|
|
|
ServerEnvironment *env, u16 id, v3f pos,
|
|
|
|
const std::string &data);
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-04-10 05:15:10 +04:00
|
|
|
/*
|
|
|
|
Some simple getters/setters
|
|
|
|
*/
|
2017-08-11 10:57:27 +03:00
|
|
|
v3f getBasePosition() const { return m_base_position; }
|
2011-11-12 13:59:56 +04:00
|
|
|
void setBasePosition(v3f pos){ m_base_position = pos; }
|
|
|
|
ServerEnvironment* getEnv(){ return m_env; }
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-11-12 13:59:56 +04:00
|
|
|
/*
|
|
|
|
Some more dynamic interface
|
|
|
|
*/
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2016-10-30 16:53:26 +03:00
|
|
|
virtual void setPos(const v3f &pos)
|
2011-11-12 17:41:29 +04:00
|
|
|
{ setBasePosition(pos); }
|
2011-11-12 15:59:56 +04:00
|
|
|
// continuous: if true, object does not stop immediately at pos
|
|
|
|
virtual void moveTo(v3f pos, bool continuous)
|
2011-11-12 17:41:29 +04:00
|
|
|
{ setBasePosition(pos); }
|
2011-11-12 17:14:24 +04:00
|
|
|
// If object has moved less than this and data has not changed,
|
|
|
|
// saving to disk may be omitted
|
2012-06-17 03:40:36 +04:00
|
|
|
virtual float getMinimumSavedMovement();
|
2011-11-12 13:59:56 +04:00
|
|
|
|
2011-11-12 19:37:14 +04:00
|
|
|
virtual std::string getDescription(){return "SAO";}
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-02-21 01:45:14 +03:00
|
|
|
/*
|
|
|
|
Step object in time.
|
|
|
|
Messages added to messages are sent to client over network.
|
2011-04-10 16:16:27 +04:00
|
|
|
|
|
|
|
send_recommended:
|
2011-04-10 17:20:31 +04:00
|
|
|
True at around 5-10 times a second, same for all objects.
|
2011-04-10 16:16:27 +04:00
|
|
|
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.
|
2011-02-21 01:45:14 +03:00
|
|
|
*/
|
2011-06-26 16:48:56 +04:00
|
|
|
virtual void step(float dtime, bool send_recommended){}
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-02-21 17:10:36 +03:00
|
|
|
/*
|
|
|
|
The return value of this is passed to the client-side object
|
|
|
|
when it is created
|
|
|
|
*/
|
2012-11-27 02:47:03 +04:00
|
|
|
virtual std::string getClientInitializationData(u16 protocol_version){return "";}
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-02-21 17:10:36 +03:00
|
|
|
/*
|
|
|
|
The return value of this is passed to the server-side object
|
2011-04-10 05:15:10 +04:00
|
|
|
when it is created (converted from static to active - actually
|
|
|
|
the data is the static form)
|
2011-02-21 17:10:36 +03:00
|
|
|
*/
|
2017-01-14 14:03:50 +03:00
|
|
|
virtual void getStaticData(std::string *result) const
|
2011-12-01 20:23:58 +04:00
|
|
|
{
|
|
|
|
assert(isStaticAllowed());
|
2017-01-12 00:48:14 +03:00
|
|
|
*result = "";
|
2011-12-01 20:23:58 +04:00
|
|
|
}
|
2011-12-01 15:22:33 +04:00
|
|
|
/*
|
|
|
|
Return false in here to never save and instead remove object
|
|
|
|
on unload. getStaticData() will not be called in that case.
|
|
|
|
*/
|
2011-12-01 20:23:58 +04:00
|
|
|
virtual bool isStaticAllowed() const
|
|
|
|
{return true;}
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2012-03-04 23:08:03 +04:00
|
|
|
// Returns tool wear
|
|
|
|
virtual int punch(v3f dir,
|
|
|
|
const ToolCapabilities *toolcap=NULL,
|
|
|
|
ServerActiveObject *puncher=NULL,
|
2011-12-02 01:33:48 +04:00
|
|
|
float time_from_last_punch=1000000)
|
2012-03-04 23:08:03 +04:00
|
|
|
{ return 0; }
|
2011-12-02 01:33:48 +04:00
|
|
|
virtual void rightClick(ServerActiveObject *clicker)
|
|
|
|
{}
|
2019-02-11 02:03:26 +03:00
|
|
|
virtual void setHP(s32 hp, const PlayerHPChangeReason &reason)
|
2011-12-02 01:33:48 +04:00
|
|
|
{}
|
2019-02-11 02:03:26 +03:00
|
|
|
virtual u16 getHP() const
|
2011-12-02 01:33:48 +04:00
|
|
|
{ return 0; }
|
2011-10-16 12:52:33 +04:00
|
|
|
|
2012-03-29 17:10:11 +04:00
|
|
|
virtual void setArmorGroups(const ItemGroupList &armor_groups)
|
|
|
|
{}
|
2019-08-01 18:11:43 +03:00
|
|
|
virtual const ItemGroupList &getArmorGroups() const
|
2018-12-16 20:44:23 +03:00
|
|
|
{ static ItemGroupList rv; return rv; }
|
2013-04-05 15:03:28 +04:00
|
|
|
virtual void setPhysicsOverride(float physics_override_speed, float physics_override_jump, float physics_override_gravity)
|
|
|
|
{}
|
2015-02-22 00:38:53 +03:00
|
|
|
virtual void setAnimation(v2f frames, float frame_speed, float frame_blend, bool frame_loop)
|
2012-10-26 19:03:24 +04:00
|
|
|
{}
|
2015-02-22 00:38:53 +03:00
|
|
|
virtual void getAnimation(v2f *frames, float *frame_speed, float *frame_blend, bool *frame_loop)
|
2015-05-26 15:10:08 +03:00
|
|
|
{}
|
2017-09-01 12:15:12 +03:00
|
|
|
virtual void setAnimationSpeed(float frame_speed)
|
|
|
|
{}
|
2015-05-27 14:23:09 +03:00
|
|
|
virtual void setBonePosition(const std::string &bone, v3f position, v3f rotation)
|
2012-10-26 19:03:24 +04:00
|
|
|
{}
|
2015-05-26 15:10:08 +03:00
|
|
|
virtual void getBonePosition(const std::string &bone, v3f *position, v3f *lotation)
|
|
|
|
{}
|
2019-07-29 20:14:07 +03:00
|
|
|
virtual const std::unordered_set<int> &getAttachmentChildIds() const
|
2018-12-16 20:44:23 +03:00
|
|
|
{ static std::unordered_set<int> rv; return rv; }
|
2018-08-05 23:28:41 +03:00
|
|
|
virtual ServerActiveObject *getParent() const { return nullptr; }
|
2012-03-30 14:26:40 +04:00
|
|
|
virtual ObjectProperties* accessObjectProperties()
|
|
|
|
{ return NULL; }
|
|
|
|
virtual void notifyObjectPropertiesModified()
|
|
|
|
{}
|
2012-03-29 17:10:11 +04:00
|
|
|
|
2012-01-12 09:10:39 +04:00
|
|
|
// Inventory and wielded item
|
2019-08-07 20:16:31 +03:00
|
|
|
virtual Inventory *getInventory() const
|
2012-01-12 09:10:39 +04:00
|
|
|
{ return NULL; }
|
|
|
|
virtual InventoryLocation getInventoryLocation() const
|
|
|
|
{ return InventoryLocation(); }
|
|
|
|
virtual void setInventoryModified()
|
|
|
|
{}
|
|
|
|
virtual std::string getWieldList() const
|
|
|
|
{ return ""; }
|
2019-08-07 20:16:31 +03:00
|
|
|
virtual u16 getWieldIndex() const
|
2012-01-12 09:10:39 +04:00
|
|
|
{ return 0; }
|
|
|
|
virtual ItemStack getWieldedItem() const;
|
|
|
|
virtual bool setWieldedItem(const ItemStack &item);
|
2016-08-04 23:09:21 +03:00
|
|
|
inline void attachParticleSpawner(u32 id)
|
|
|
|
{
|
|
|
|
m_attached_particle_spawners.insert(id);
|
|
|
|
}
|
|
|
|
inline void detachParticleSpawner(u32 id)
|
|
|
|
{
|
|
|
|
m_attached_particle_spawners.erase(id);
|
|
|
|
}
|
|
|
|
|
2012-01-12 09:10:39 +04:00
|
|
|
|
2011-05-22 18:00:09 +04:00
|
|
|
/*
|
|
|
|
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.
|
|
|
|
*/
|
2017-06-21 12:51:29 +03:00
|
|
|
u16 m_known_by_count = 0;
|
2011-05-22 18:00:09 +04:00
|
|
|
|
2011-02-21 01:45:14 +03:00
|
|
|
/*
|
2011-04-08 01:47:14 +04:00
|
|
|
- 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.
|
2017-09-15 13:19:01 +03:00
|
|
|
- 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.
|
2011-02-21 01:45:14 +03:00
|
|
|
*/
|
2017-09-15 13:19:01 +03:00
|
|
|
bool m_pending_removal = false;
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-05-22 18:00:09 +04:00
|
|
|
/*
|
2017-09-15 13:19:01 +03:00
|
|
|
Same purpose as m_pending_removal but for deactivation.
|
|
|
|
deactvation = save static data in block, remove active object
|
2011-05-22 18:00:09 +04:00
|
|
|
|
2017-09-15 13:19:01 +03:00
|
|
|
If this is set alongside with m_pending_removal, removal takes
|
|
|
|
priority.
|
2011-05-22 18:00:09 +04:00
|
|
|
*/
|
2017-06-21 12:51:29 +03:00
|
|
|
bool m_pending_deactivation = false;
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2017-09-15 13:19:01 +03:00
|
|
|
/*
|
|
|
|
A getter that unifies the above to answer the question:
|
|
|
|
"Can the environment still interact with this object?"
|
|
|
|
*/
|
|
|
|
inline bool isGone() const
|
|
|
|
{ return m_pending_removal || m_pending_deactivation; }
|
|
|
|
|
2011-04-10 05:15:10 +04:00
|
|
|
/*
|
|
|
|
Whether the object's static data has been stored to a block
|
|
|
|
*/
|
2017-06-21 12:51:29 +03:00
|
|
|
bool m_static_exists = false;
|
2011-04-10 05:15:10 +04:00
|
|
|
/*
|
|
|
|
The block from which the object was loaded from, and in which
|
|
|
|
a copy of the static data resides.
|
|
|
|
*/
|
2017-06-21 12:51:29 +03:00
|
|
|
v3s16 m_static_block = v3s16(1337,1337,1337);
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-06-26 16:48:56 +04:00
|
|
|
/*
|
|
|
|
Queue of messages to be sent to the client
|
|
|
|
*/
|
2015-03-04 19:48:07 +03:00
|
|
|
std::queue<ActiveObjectMessage> m_messages_out;
|
2016-10-08 13:21:41 +03:00
|
|
|
|
2011-02-21 01:45:14 +03:00
|
|
|
protected:
|
2018-04-30 19:43:49 +03:00
|
|
|
virtual void onAttach(int parent_id) {}
|
|
|
|
virtual void onDetach(int parent_id) {}
|
|
|
|
|
2011-04-10 05:15:10 +04:00
|
|
|
// Used for creating objects based on type
|
|
|
|
typedef ServerActiveObject* (*Factory)
|
2011-11-11 21:33:17 +04:00
|
|
|
(ServerEnvironment *env, v3f pos,
|
2011-04-10 05:15:10 +04:00
|
|
|
const std::string &data);
|
|
|
|
static void registerType(u16 type, Factory f);
|
|
|
|
|
2011-02-21 17:10:36 +03:00
|
|
|
ServerEnvironment *m_env;
|
2011-02-21 01:45:14 +03:00
|
|
|
v3f m_base_position;
|
2017-06-04 22:00:04 +03:00
|
|
|
std::unordered_set<u32> m_attached_particle_spawners;
|
2011-04-10 05:15:10 +04:00
|
|
|
|
|
|
|
private:
|
|
|
|
// Used for creating objects based on type
|
2012-12-20 21:19:49 +04:00
|
|
|
static std::map<u16, Factory> m_types;
|
2011-02-21 01:45:14 +03:00
|
|
|
};
|