summaryrefslogtreecommitdiff
path: root/src/game-server/entity.h
blob: 9d418df36b6e6b74dfe2dcbb5ed5a6bfddf4d96f (plain) (blame)
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
156
157
158
/*
 *  The Mana Server
 *  Copyright (C) 2004-2010  The Mana World Development Team
 *  Copyright (C) 2012  The Mana Developers
 *
 *  This file is part of The Mana Server.
 *
 *  The Mana Server 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
 *  any later version.
 *
 *  The Mana Server 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 The Mana Server.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENTITY_H
#define ENTITY_H

#include "common/manaserv_protocol.h"

#include "game-server/component.h"

#include <sigc++/signal.h>
#include <sigc++/trackable.h>

#include <cassert>

using namespace ManaServ;

class MapComposite;

/**
 * Base class for in-game objects.
 *
 * Knows its type, the map it resides on and is host to a number of optional
 * components.
 */
class Entity : public sigc::trackable
{
    public:
        Entity(EntityType type, MapComposite *map = 0);

        virtual ~Entity();

        EntityType getType() const;

        template <class T> void addComponent(T *component);
        template <class T> T *getComponent() const;

        Component *getComponent(ComponentType type) const;

        bool isVisible() const;
        bool canMove() const;
        bool canFight() const;

        virtual void update();

        MapComposite *getMap() const;
        virtual void setMap(MapComposite *map);

        sigc::signal<void, Entity *> signal_inserted;
        sigc::signal<void, Entity *> signal_removed;

    private:
        MapComposite *mMap;     /**< Map the entity is on */
        EntityType mType;       /**< Type of this entity. */

        Component *mComponents[ComponentTypeCount];
};

/**
 * Gets type of this entity.
 *
 * @return the type of this entity.
 */
inline EntityType Entity::getType() const
{
    return mType;
}

/**
 * Adds a component. Only one component of a given type can be added.
 * Entity takes ownership of \a component.
 */
template <class T>
inline void Entity::addComponent(T *component)
{
    assert(!mComponents[T::type]);
    mComponents[T::type] = component;
}

/**
 * Returns the component of the given type, or 0 when no such component
 * was set.
 */
inline Component *Entity::getComponent(ComponentType type) const
{
    return mComponents[type];
}

/**
 * Get a component by its class. Avoids the need for doing a static-
 * cast in the calling code.
 */
template <class T>
inline T *Entity::getComponent() const
{
    return static_cast<T*>(getComponent(T::type));
}

/**
 * Returns whether this entity is visible on the map or not. (Actor)
 */
inline bool Entity::isVisible() const
{
    return mType != OBJECT_OTHER;
}

/**
 * Returns whether this entity can move on the map or not. (Actor)
 */
inline bool Entity::canMove() const
{
    return mType == OBJECT_CHARACTER || mType == OBJECT_MONSTER ||
           mType == OBJECT_NPC;
}

/**
 * Returns whether this entity can fight or not. (Being)
 */
inline bool Entity::canFight() const
{
    return mType == OBJECT_CHARACTER || mType == OBJECT_MONSTER;
}

/**
 * Gets the map this entity is located on.
 */
inline MapComposite *Entity::getMap() const
{
    return mMap;
}

/**
 * Sets the map this entity is located on.
 */
inline void Entity::setMap(MapComposite *map)
{
    mMap = map;
}

#endif // ENTITY_H