summaryrefslogtreecommitdiff
path: root/src/being.h
blob: 80b73012fce3a803324a9c2f072e3cddec90dbd3 (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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/*
 *  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_BEING_H_
#define _TMWSERV_BEING_H_


#include <string>
#include <vector>

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

const unsigned int MAX_EQUIP_SLOTS = 5; /**< Maximum number of equipped slots */

namespace tmwserv
{


struct PATH_NODE {
    /**
     * Constructor.
     */
    PATH_NODE(unsigned short x, unsigned short y);

    unsigned short x, y;
};

/**
 * Structure type for the raw statistics of a Being.
 */
struct RawStatistics
{
    unsigned short strength;
    unsigned short agility;
    unsigned short vitality;
    unsigned short intelligence;
    unsigned short dexterity;
    unsigned short luck;
};


/**
 * Generic Being (living object).
 * Used for players & monsters (all animated objects).
 */
class Being: public Object
{
    public:
        /**
         * Constructor.
         */
        Being(const std::string& name,
              const Genders gender,
              const unsigned short hairStyle,
              const unsigned short hairColor,
              const unsigned short level,
              const unsigned int money,
              const RawStatistics& stats);

        /**
         * Destructor.
         */
        ~Being(void)
            throw();

        /**
         * Gets the name.
         *
         * @return the name.
         */
        const std::string&
        getName(void) const;

        /**
         * Gets the hair Style.
         *
         * @return the Hair style value.
         */
        unsigned short
        getHairStyle(void) const;

        /**
         * Gets the Hair Color.
         *
         * @return the Hair Color value.
         */
        unsigned short
        getHairColor(void) const;

        /**
         * Gets the gender.
         *
         * @return the gender.
         */
        Genders
        getGender(void) const;


        /**
         * Sets the level.
         *
         * @param level the new level.
         */
        void
        setLevel(const unsigned short level);

        /**
         * Gets the level.
         *
         * @return the level.
         */
        unsigned short
        getLevel(void) const;

        /**
         * Sets the money.
         *
         * @param amount the new amount.
         */
        void
        setMoney(const unsigned int amount);

        /**
         * Gets the amount of money.
         *
         * @return the amount of money.
         */
        unsigned int
        getMoney(void) const;

        /**
         * Sets the strength.
         *
         * @param strength the new strength.
         */
        void
        setStrength(const unsigned short strength);

        /**
         * Gets the strength.
         *
         * @return the strength.
         */
        unsigned short
        getStrength(void) const;

        /**
         * Sets the agility.
         *
         * @param agility the new agility.
         */
        void
        setAgility(const unsigned short agility);

        /**
         * Gets the agility.
         *
         * @return the agility.
         */
        unsigned short
        getAgility(void) const;

        /**
         * Sets the vitality.
         *
         * @param vitality the new vitality.
         */
        void
        setVitality(const unsigned short vitality);

        /**
         * Gets the vitality.
         *
         * @return the vitality.
         */
        unsigned short
        getVitality(void) const;

        /**
         * Sets the intelligence.
         *
         * @param intelligence the new intelligence.
         */
        void
        setIntelligence(const unsigned short intelligence);

        /**
         * Gets the intelligence.
         *
         * @return the intelligence.
         */
        unsigned short
        getIntelligence(void) const;

        /**
         * Sets the dexterity.
         *
         * @param dexterity the new dexterity.
         */
        void
        setDexterity(const unsigned short dexterity);

        /**
         * Gets the dexterity.
         *
         * @return the dexterity.
         */
        unsigned short
        getDexterity(void) const;

        /**
         * Sets the luck.
         *
         * @param luck the new luck.
         */
        void
        setLuck(const unsigned short luck);

        /**
         * Gets the luck.
         *
         * @return the luck.
         */
        unsigned short
        getLuck(void) const;

        /**
         * Sets the raw statistics.
         *
         * @param stats the new raw statistics.
         */
        void
        setRawStatistics(const RawStatistics& stats);

        /**
         * Gets the raw statistics.
         *
         * @return the raw statistics.
         */
        RawStatistics&
        getRawStatistics(void);

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

        /**
         * Sets inventory.
         */
        void
        setInventory(const std::vector<unsigned int> &inven);

        /**
         * Adds item with ID to inventory.
         *
         * @return Item add success/failure
         */
        bool
        addInventory(unsigned int itemId);

        /**
         * Removes item with ID from inventory.
         *
         * @return Item delete success/failure
         */
        bool
        delInventory(unsigned int itemId);

        /**
         * Checks if character has an item.
         *
         * @return true if being has item, false otherwise
         */
        bool
        hasItem(unsigned int itemId);

        /**
         * Equips item with ID in equipment slot.
         *
         * @return Equip success/failure
         */
        bool
        equip(unsigned int itemId, unsigned char slot);

        /**
         * Un-equips item.
         *
         * @return Un-equip success/failure
         */
        bool
        unequip(unsigned char slot);

    private:
        /**
         * Copy constructor.
         */
        Being(const Being& rhs);

        /**
         * Assignment operator.
         */
        Being&
        operator=(const Being& rhs);

        std::string mName;       /**< name of the being */
        Genders mGender;         /**< gender of the being */
        unsigned short mHairStyle;/**< Hair Style of the being */
        unsigned short mHairColor;/**< Hair Color of the being */
        unsigned short mLevel;   /**< level of the being */
        unsigned int mMoney;     /**< wealth of the being */
        RawStatistics mRawStats; /**< raw stats of the being */

        std::vector<unsigned int> inventory;    /**< Player inventory */
        unsigned int equipment[MAX_EQUIP_SLOTS]; /**< Equipped item ID's (from inventory) */
};


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


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


} // namespace tmwserv


#endif // _TMWSERV_BEING_H_