summaryrefslogtreecommitdiff
path: root/src/object.h
blob: 05b1f45d6d2564473a17b813b9e2a2862de180ed (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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
 *  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
 *
 *  $Id$
 */


#ifndef _TMWSERV_OBJECT_H_
#define _TMWSERV_OBJECT_H_

#include <utility>
#include <vector>

#include "defines.h"
#include "utils/countedptr.h"

/**
 * Generic in-game object definition.
 * Base class for in-game objects.
 */
class Object
{
    public:
        /**
         * Constructor.
         */
        Object(int type, int id)
          : mType(type),
            mID(id),
            mNeedUpdate(false)
        {}

        /**
         * Empty virtual destructor.
         */
        virtual ~Object() {}

        /**
         * Get type.
         *
         * @return the type.
         */
        unsigned int getType() const
        { return mType; }

        /**
         * Get object ID.
         *
         * @return the unique ID, a negative number if none yet.
         */
        int getID() const
        { return mID; }

        /**
         * Set object ID.
         * The account shall not have any ID yet.
         */
        void setID(int id);

        /**
         * Set the x coordinate.
         *
         * @param x the new x coordinate.
         */
        void setX(unsigned int x)
        { mX = x; }

        /**
         * Get the x coordinate.
         *
         * @return the x coordinate.
         */
        unsigned int getX() const
        { return mX; }

        /**
         * Set the y coordinate.
         *
         * @param y the new y coordinate.
         */
        void setY(unsigned int y)
        { mY = y; }

        /**
         * Get the y coordinate.
         *
         * @return the y coordinate.
         */
        unsigned int getY() const
        { return mY; }

        /**
         * Set the coordinates.
         *
         * @param x the x coordinate.
         * @param y the y coordinate.
         */
        void setXY(unsigned int x, unsigned int y)
        { mX = x; mY = y; }

        /**
         * Get the coordinates.
         *
         * @return the coordinates as a pair.
         */
        std::pair<unsigned int, unsigned int> getXY() const
        { return std::make_pair(mX, mY); }

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

        /**
         * Get map name where being is
         *
         * @return Name of map being is located.
         */
        unsigned int getMapId() const
        { return mMapId; }

        /**
         * Set map being is located
         */
        void setMapId(unsigned int mapId)
        { mMapId = mapId; }

    private:
        int mType; /**< Object type */
        int mID; /** Object unique ID (wrt its type and its map at least) */
        unsigned int mX; /**< x coordinate */
        unsigned int mY; /**< y coordinate */
        unsigned int mMapId;  /**< id of the map being is on */

    protected:
        bool mNeedUpdate;  /**< update() must be invoked if true */
};

/**
 * Base class for in-game moving objects.
 */
class MovingObject: public Object
{
    public:
        /**
         * Proxy constructor.
         */
        MovingObject(int type, int id)
          : Object(type, id)
        {}

        /**
         * Gets the destination coordinates of the object.
         */
        std::pair<unsigned, unsigned> getDestination() const
        { return std::make_pair(mDstX, mDstY); }

        /**
         * Sets the destination coordinates of the object.
         */
        void setDestination(unsigned x, unsigned y)
        { mDstX = x; mDstY = y; }

        /**
         * Gets the next coordinates of the object.
         */
        std::pair<unsigned, unsigned> getNextPosition() const
        { return std::make_pair(mNewX, mNewY); }

        /**
         * Sets object speed.
         */
        void setSpeed(unsigned s)
        { mSpeed = s; }

        /**
         * Moves the object toward its destination.
         */
        void move();

    private:
        unsigned mDstX; /**< target x coordinate */
        unsigned mDstY; /**< target y coordinate */
        unsigned mNewX; /**< next x coordinate */
        unsigned mNewY; /**< next y coordinate */
        unsigned mSpeed; /**< speed */
};

/**
 * Type definition for a smart pointer to Object.
 */
typedef utils::CountedPtr<Object> ObjectPtr;


/**
 * Type definition for a list of Objects.
 */
typedef std::vector<ObjectPtr> Objects;

#endif // _TMWSERV_OBJECT_H_