mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
1a59d10ddd
* server/CommClient.h, server/CommListener.h, server/CommLocalClient.h, server/CommMDNSPublisher.h, server/CommMaster.h, server/CommMetaClient.h, server/CommPSQLSocket.h, server/CommPeer.h, server/CommPeerListener.h, server/CommRemoteClient.h, server/CommServer.h, server/CommSlaveClient.h, server/CommSlaveListener.h, server/CommSocket.cpp, server/CommSocket.h, server/CommUnixListener.h: Add a documentation group for socket classes. * rulesets/Py_BBox.h, rulesets/Py_EntityWrapper.h, rulesets/Py_Location.h, rulesets/Py_Map.h, rulesets/Py_Mind.h, rulesets/Py_Object.h, rulesets/Py_Operation.h, rulesets/Py_Oplist.h, rulesets/Py_Optime.h, rulesets/Py_Point3D.h, rulesets/Py_Property.h, rulesets/Py_Quaternion.h, rulesets/Py_RootEntity.h, rulesets/Py_Task.h, rulesets/Py_Thing.h, rulesets/Py_Vector3D.h, rulesets/Py_World.h, rulesets/Py_WorldTime.h, rulesets/Python_API.cpp: Add documentation group for Python wrapper types. * rulesets/Container.h, rulesets/PythonScript.cpp, server/ScriptFactory.h, server/ScriptFactory.cpp: Add more inline documentation comments.
70 lines
2.3 KiB
C++
70 lines
2.3 KiB
C++
// Cyphesis Online RPG Server and AI Engine
|
|
// Copyright (C) 2005 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
|
|
|
|
// $Id: ScriptFactory.h,v 1.7 2006-12-22 02:14:45 alriddoch Exp $
|
|
|
|
#ifndef SERVER_SCRIPT_FACTORY_H
|
|
#define SERVER_SCRIPT_FACTORY_H
|
|
|
|
#include <Python.h>
|
|
|
|
#include <string>
|
|
|
|
class Entity;
|
|
|
|
/// \brief Factory interface for creating scripts to attach to in game
|
|
/// entity objects.
|
|
class ScriptFactory {
|
|
protected:
|
|
/// \brief Name of the script package where the script type is
|
|
std::string m_package;
|
|
/// \brief Name of the script type instanced by this factory
|
|
std::string m_type;
|
|
|
|
ScriptFactory(const std::string & package, const std::string & type);
|
|
public:
|
|
virtual ~ScriptFactory();
|
|
|
|
/// \brief Accessor for package name
|
|
const std::string & package() { return m_package; }
|
|
|
|
/// \brief Add a script to an entity
|
|
virtual int addScript(Entity * entity) = 0;
|
|
/// \brief Reload the underlying class object from the script on disk
|
|
virtual int refreshClass() = 0;
|
|
};
|
|
|
|
/// \brief Factory implementation for creating python script objects to attach
|
|
/// to in game entity objects.
|
|
class PythonScriptFactory : public ScriptFactory {
|
|
protected:
|
|
/// \brief Module object which contains the script class
|
|
PyObject * m_module;
|
|
/// \brief Class object to be instanced when creating scripts
|
|
PyObject * m_class;
|
|
|
|
int getClass();
|
|
public:
|
|
PythonScriptFactory(const std::string & package, const std::string & type);
|
|
~PythonScriptFactory();
|
|
|
|
int addScript(Entity * entity);
|
|
int refreshClass();
|
|
|
|
};
|
|
|
|
#endif // SERVER_SCRIPT_FACTORY_H
|