1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2000-2007 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: LocatedEntity.h,v 1.14 2008-01-28 23:48:32 alriddoch Exp $
#ifndef RULESETS_LOCATED_ENTITY_H
#define RULESETS_LOCATED_ENTITY_H
#include "modules/Location.h"
#include "common/Identified.h"
#include <set>
class LocatedEntity;
class PropertyBase;
class Script;
class TypeNode;
typedef std::set<LocatedEntity *> LocatedEntitySet;
typedef std::map<std::string, PropertyBase *> PropertyDict;
/// \brief This is the base class from which in-game and in-memory objects
/// inherit.
///
/// This class should not normally be instantiated directly.
/// This class provides hard-coded attributes that are common to all
/// in-game objects, and objects in the memory on an NPC.
/// It provides a physical location for the entity, and a contains list
/// which lists other entities which specify their location with reference to
/// this one. It also provides the script interface for handling operations
/// in scripts rather than in the C++ code.
class LocatedEntity : public IdentifiedRouter {
private:
static std::set<std::string> m_immutable;
static const std::set<std::string> & immutables();
/// Count of references held by other objects to this entity
int m_refCount;
protected:
/// Map of properties
PropertyDict m_properties;
/// Sequence number
int m_seq;
/// Script associated with this entity
Script * m_script;
/// Class of which this is an instance
const TypeNode * m_type;
public:
/// Full details of location
Location m_location;
/// List of entities which use this as ref
LocatedEntitySet * m_contains;
explicit LocatedEntity(const std::string & id, long intId);
virtual ~LocatedEntity();
/// \brief Increment the reference count on this entity
void incRef() {
++m_refCount;
}
/// \brief Decrement the reference count on this entity
void decRef() {
if (m_refCount <= 0) {
assert(m_refCount == 0);
delete this;
} else {
--m_refCount;
}
}
/// \brief Check the reference count on this entity
int checkRef() const {
return m_refCount;
}
/// \brief Accessor for pointer to script object
Script * script() const {
return m_script;
}
/// \brief Accessor for sequence number
const int getSeq() const { return m_seq; }
/// \brief Accessor for entity type property
const TypeNode * getType() const { return m_type; }
/// \brief Set the value of the entity type property
void setType(const TypeNode * t) {
m_type = t;
}
virtual bool hasAttr(const std::string & name) const;
virtual bool getAttr(const std::string & name,
Atlas::Message::Element &) const;
virtual void setAttr(const std::string & name,
const Atlas::Message::Element &);
virtual PropertyBase * getProperty(const std::string & name) const;
virtual void onContainered();
void setScript(Script * scrpt);
void makeContainer();
void changeContainer(LocatedEntity *);
void merge(const Atlas::Message::MapType &);
/// \brief Get a property that is required to of a given type.
template <class PropertyT>
PropertyT * getSpecificProperty(const std::string & name)
{
PropertyBase * p = getProperty(name);
if (p != 0) {
return dynamic_cast<PropertyT *>(p);
}
return 0;
}
/// \brief Require that a property of a given type is set.
template <class PropertyT>
PropertyT * requireSpecificProperty(const std::string & name,
const Atlas::Message::Element & def_val
= Atlas::Message::Element())
{
PropertyBase * p = getProperty(name);
PropertyT * sp = 0;
if (p != 0) {
sp = dynamic_cast<PropertyT *>(p);
}
if (sp == 0) {
m_properties[name] = sp = new PropertyT;
sp->set(def_val);
}
return sp;
}
};
#endif // RULESETS_LOCATED_ENTITY_H
|
