mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
294c781dc7
* common/Use.h, common/Wield.h, common/Generic.h: Mark unused files as removed from the build. * common/Attack.h, common/Burn.h, common/Chop.h, common/Connect.h, common/Cut.h, common/Delve.h, common/Dig.h, common/Drop.h, common/Eat.h, common/Monitor.h, common/Mow.h, common/Nourish.h, common/Pickup.h, common/Setup.h, common/Tick.h, common/Unseen.h, common/Update.h: Add class documentation to all the custom properties. * common/DynamicProperty.h, client/ClientPropertyManager.h, server/CorePropertyManager.h, server/PersistantThingFactory.h, server/ScriptFactory.h, server/WorldRouter.cpp: Add documentation to some places where it is missing.
124 lines
4.1 KiB
C++
124 lines
4.1 KiB
C++
// Cyphesis Online RPG Server and AI Engine
|
|
// Copyright (C) 2000,2001 Alistair Riddoch
|
|
//
|
|
// 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
|
|
// (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.
|
|
//
|
|
// You should have received a copy of the GNU 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 SERVER_THING_FACTORY_H
|
|
#define SERVER_THING_FACTORY_H
|
|
|
|
#include <Atlas/Message/Element.h>
|
|
|
|
#include <set>
|
|
|
|
class Entity;
|
|
|
|
template <class T>
|
|
class Persistor;
|
|
|
|
class ScriptFactory;
|
|
|
|
/// \brief Interface class for connecting a newly created entity to its
|
|
/// persistor
|
|
class PersistorBase {
|
|
public:
|
|
virtual ~PersistorBase() { }
|
|
|
|
virtual void persist() = 0;
|
|
};
|
|
|
|
/// \brief Class template for connecting a newly created entity to its
|
|
/// persistor
|
|
template <class T>
|
|
class PersistorConnection : public PersistorBase {
|
|
private:
|
|
T & m_t;
|
|
Persistor<T> & m_p;
|
|
public:
|
|
PersistorConnection(T & t, Persistor<T> & p) : m_t(t), m_p(p) { }
|
|
|
|
/// Use p to hook up t into the persistance code
|
|
void persist();
|
|
};
|
|
|
|
/// \brief Base class for for factories for creating entities
|
|
///
|
|
/// An Entity consists of an instance of one of a number of C++ classes
|
|
/// optionally with a script. Stores information about default attributes,
|
|
/// script language and class name.
|
|
class FactoryBase {
|
|
protected:
|
|
FactoryBase();
|
|
public:
|
|
ScriptFactory * m_scriptFactory;
|
|
/// Default attribute values for this class
|
|
Atlas::Message::MapType m_classAttributes;
|
|
/// Default attribute values for instances of this class, including
|
|
/// defaults inherited from parent classes.
|
|
Atlas::Message::MapType m_attributes;
|
|
/// Factory for class from which the class handled by this factory
|
|
/// inherits.
|
|
FactoryBase * m_parent;
|
|
/// Set of factories for classes which inherit from the class handled
|
|
/// by this factory.
|
|
std::set<FactoryBase *> m_children;
|
|
|
|
virtual ~FactoryBase();
|
|
|
|
virtual Entity * newThing(const std::string & id, long intId) = 0;
|
|
virtual Entity * newPersistantThing(const std::string & id, long intId, PersistorBase **) = 0;
|
|
virtual int populate(Entity &) = 0;
|
|
virtual FactoryBase * duplicateFactory() = 0;
|
|
};
|
|
|
|
// How do we make sure the peristance hooks are put in place in a typesafe way
|
|
// but after all the initial attribute have been set.
|
|
|
|
/// \brief Class template for factories for creating instances of the give
|
|
/// entity class
|
|
template <class T>
|
|
class PersistantThingFactory : public FactoryBase {
|
|
protected:
|
|
PersistantThingFactory(PersistantThingFactory<T> & p) : m_p(p.m_p),
|
|
m_master(false) { }
|
|
public:
|
|
Persistor<T> & m_p;
|
|
const bool m_master;
|
|
|
|
PersistantThingFactory() : m_p(* new Persistor<T>()), m_master(true) { }
|
|
virtual ~PersistantThingFactory();
|
|
|
|
virtual T * newThing(const std::string & id, long intId);
|
|
virtual T * newPersistantThing(const std::string & id, long intId, PersistorBase ** p);
|
|
virtual int populate(Entity &);
|
|
virtual FactoryBase * duplicateFactory();
|
|
};
|
|
|
|
/// \brief Class template for factories for entity classes which cannot or
|
|
/// should not be instanced
|
|
template <class T>
|
|
class ForbiddenThingFactory : public FactoryBase {
|
|
public:
|
|
Persistor<T> & m_p;
|
|
ForbiddenThingFactory() : m_p(* new Persistor<T>()) { }
|
|
|
|
virtual ~ForbiddenThingFactory();
|
|
|
|
virtual T * newThing(const std::string & id, long intId);
|
|
virtual T * newPersistantThing(const std::string & id, long intId, PersistorBase ** p);
|
|
virtual int populate(Entity &);
|
|
virtual FactoryBase * duplicateFactory();
|
|
};
|
|
|
|
#endif // SERVER_THING_FACTORY_H
|