summaryrefslogtreecommitdiff
path: root/src/game-server/thing.hpp
blob: 33ffa90866ea58f24286016dd652c54bfd79dd30 (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
/*
 *  The Mana World Server
 *  Copyright 2004 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World  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  World 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  World; if not, write to the  Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _TMWSERV_THING_H_
#define _TMWSERV_THING_H_

#include <set>

class EventListener;
class MapComposite;

/**
 * Types of things enumeration.
 */
enum ThingType
{
    OBJECT_ITEM = 0,  /**< A simple item. */
    OBJECT_ACTOR,     /**< An item that toggle map/quest actions (doors,
                           switchs, ...) and can speak (map panels). */
    OBJECT_NPC,       /**< Non-Playable-Character is an actor capable of
                           movement and maybe actions. */
    OBJECT_MONSTER,   /**< A monster (moving actor with AI. Should be able to
                           toggle map/quest actions, too). */
    OBJECT_CHARACTER, /**< A normal being. */
    OBJECT_EFFECT,    /**< A effect to be shown */
    OBJECT_OTHER      /**< Server-only object. */
};

/**
 * Base class for in-game objects. Knows only its type and the map it resides
 * on. Provides listeners.
 */
class Thing
{
    public:
        /**
         * Constructor.
         */
        Thing(ThingType type, MapComposite *map = NULL)
          : mMap(map),
            mType(type)
        {}

        virtual ~Thing();

        /**
         * Gets type of this thing.
         *
         * @return the type of this thing.
         */
        ThingType getType() const
        { return mType; }

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

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

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

        /**
         * Updates the internal status.
         */
        virtual void update() = 0;

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

        /**
         * Sets the map this thing is located on.
         */
        virtual void setMap(MapComposite *map)
        { mMap = map; }

        /**
         * Adds a new listener.
         */
        void addListener(const EventListener *);

        /**
         * Removes an existing listener.
         */
        void removeListener(const EventListener *);

        /**
         * Calls all the "inserted" listeners.
         */
        virtual void inserted();

        /**
         * Calls all the "removed" listeners.
         */
        virtual void removed();

    protected:
        typedef std::set< const EventListener * > Listeners;
        Listeners mListeners;   /**< List of event listeners. */

    private:
        MapComposite *mMap;     /**< Map the thing is on */
        ThingType mType;        /**< Type of this thing. */
};

#endif // _TMWSERV_THING_H_