summaryrefslogtreecommitdiff
path: root/src/resources/iteminfo.h
blob: 3846268563b8f938b65662c2744de68df5ae6750 (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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2017  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  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
 *  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, see <http://www.gnu.org/licenses/>.
 */

#ifndef RESOURCES_ITEMINFO_H
#define RESOURCES_ITEMINFO_H

#include "enums/being/gender.h"

#include "enums/resources/item/itemdbtype.h"

#include "enums/simpletypes/beingtypeid.h"

#include "resources/cursors.h"
#include "resources/itemcolordata.h"
#include "resources/soundinfo.h"

#include "resources/sprite/spritedisplay.h"

#include "utils/intmap.h"

// sprite, <itemfrom, itemto>
typedef std::map<int, IntMap> SpriteToItemMap;
typedef SpriteToItemMap::const_iterator SpriteToItemMapCIter;

/**
 * Defines a class for storing item infos. This includes information used when
 * the item is equipped.
 */
class ItemInfo final
{
    public:
        /**
         * Constructor.
         */
        ItemInfo();

        A_DELETE_COPY(ItemInfo)

        ~ItemInfo();

        void setId(const int id) noexcept2
        { mId = id; }

        int getId() const noexcept2 A_WARN_UNUSED
        { return mId; }

        void setName(const std::string &name) noexcept2
        { mName = name; }

        const std::string &getName() const noexcept2 A_WARN_UNUSED
        { return mName; }

        const std::string getName(const ItemColor color)
                                  const A_WARN_UNUSED;

        void setNameEn(const std::string &name) noexcept2
        { mNameEn = name; }

        const std::string &getNameEn() const noexcept2 A_WARN_UNUSED
        { return mNameEn; }

        const std::string getNameEn(const ItemColor color)
                                    const A_WARN_UNUSED;

        const std::string getLink() const A_WARN_UNUSED;

        void setDisplay(const SpriteDisplay &display) noexcept2
        { mDisplay = display; }

        const SpriteDisplay &getDisplay() const noexcept2 A_WARN_UNUSED
        { return mDisplay; }

        void setDescription(const std::string &description) noexcept2
        { mDescription = description; }

        const std::string &getDescription() const noexcept2 A_WARN_UNUSED
        { return mDescription; }

        const std::string getDescription(const ItemColor color)
                                         const A_WARN_UNUSED;

        void setEffect(const std::string &effect) noexcept2
        { mEffect = effect; }

        const std::string &getEffect() const noexcept2 A_WARN_UNUSED
        { return mEffect; }

        void setType(const ItemDbTypeT type) noexcept2
        { mType = type; }

        void setUseButton(const std::string &str) noexcept2
        { mUseButton = str; }

        const std::string &getUseButton() const noexcept2 A_WARN_UNUSED
        { return mUseButton; }

        void setUseButton2(const std::string &str) noexcept2
        { mUseButton2 = str; }

        const std::string &getUseButton2() const noexcept2 A_WARN_UNUSED
        { return mUseButton2; }

        ItemDbTypeT getType() const noexcept2 A_WARN_UNUSED
        { return mType; }

        void setWeight(const int weight) noexcept2
        { mWeight = weight; }

        int getWeight() const noexcept2 A_WARN_UNUSED
        { return mWeight; }

        int getView() const noexcept2 A_WARN_UNUSED
        { return mView; }

        void setView(const int view) noexcept2
        { mView = view; }

        void setSprite(const std::string &animationFile,
                       const GenderT gender, const int race);

        const std::string &getSprite(const GenderT gender,
                                     const BeingTypeId race)
                                     const A_WARN_UNUSED;

        void setAttackAction(const std::string &attackAction);

        void setSkyAttackAction(const std::string &attackAction);

        void setWaterAttackAction(const std::string &attackAction);

        void setRideAttackAction(const std::string &attackAction);

        // Handlers for seting and getting the string
        // used for particles when attacking
        void setMissileParticleFile(const std::string &s) noexcept2
        { mMissileParticleFile = s; }

        const std::string &getMissileParticleFile() const noexcept2
                                                  A_WARN_UNUSED
        { return mMissileParticleFile; }

        void setHitEffectId(const int s) noexcept2
        { mHitEffectId = s; }

        int getHitEffectId() const noexcept2 A_WARN_UNUSED
        { return mHitEffectId; }

        void setCriticalHitEffectId(const int s) noexcept2
        { mCriticalHitEffectId = s; }

        int getCriticalHitEffectId() const noexcept2 A_WARN_UNUSED
        { return mCriticalHitEffectId; }

        void setMissEffectId(const int s) noexcept2
        { mMissEffectId = s; }

        int getMissEffectId() const noexcept2 A_WARN_UNUSED
        { return mMissEffectId; }

        const std::string &getAttackAction() const noexcept2 A_WARN_UNUSED
        { return mAttackAction; }

        const std::string &getSkyAttackAction() const noexcept2 A_WARN_UNUSED
        { return mSkyAttackAction; }

        const std::string &getWaterAttackAction() const noexcept2 A_WARN_UNUSED
        { return mWaterAttackAction; }

        const std::string &getRideAttackAction() const noexcept2 A_WARN_UNUSED
        { return mRideAttackAction; }

        int getAttackRange() const noexcept2 A_WARN_UNUSED
        { return mAttackRange; }

        void setAttackRange(const int r) noexcept2
        { mAttackRange = r; }

        void addSound(const ItemSoundEvent::Type event,
                      const std::string &filename,
                      const int delay);

        const SoundInfo &getSound(const ItemSoundEvent::Type event)
                                  const A_WARN_UNUSED;

        int getDrawBefore(const int direction) const A_WARN_UNUSED;

        void setDrawBefore(const int direction, const int n);

        int getDrawAfter(const int direction) const A_WARN_UNUSED;

        void setDrawAfter(const int direction, const int n);

        int getDrawPriority(const int direction) const A_WARN_UNUSED;

        void setDrawPriority(const int direction, const int n);

        const IntMap &getTags() const noexcept2 A_WARN_UNUSED
        { return mTags; }

        void addTag(const int tag)
        { mTags[tag] = 1; }

        void setRemoveSprites() noexcept2
        { mIsRemoveSprites = true; }

        bool isRemoveSprites() const noexcept2 A_WARN_UNUSED
        { return mIsRemoveSprites; }

        void setMaxFloorOffsetX(const int i) noexcept2
        { maxFloorOffsetX = i; }

        void setMaxFloorOffsetY(const int i) noexcept2
        { maxFloorOffsetY = i; }

        int getMaxFloorOffsetX() const noexcept2 A_WARN_UNUSED
        { return maxFloorOffsetX; }

        int getMaxFloorOffsetY() const noexcept2 A_WARN_UNUSED
        { return maxFloorOffsetY; }

        bool isRemoveItemId(int id) const A_WARN_UNUSED;

        void setCardColor(const ItemColor color) noexcept2
        { mCardColor = color; }

        ItemColor getCardColor() const noexcept2
        { return mCardColor; }

        /** Effects to be shown when weapon attacks - see also effects.xml */
        std::string mMissileParticleFile;

        int getReplaceToSpriteId(int id) const A_WARN_UNUSED;

        IntMap *addReplaceSprite(const int sprite,
                                 const int direction);

        const SpriteToItemMap *getSpriteToItemReplaceMap(const int directions)
                                                         const A_WARN_UNUSED;

        std::string getDyeColorsString(const ItemColor color)
                                       const A_WARN_UNUSED;

        std::string getDyeIconColorsString(const ItemColor color)
                                           const A_WARN_UNUSED;

        void setColorsList(const std::string &name);

        void setIconColorsList(const std::string &name);

        bool isHaveColors() const noexcept2 A_WARN_UNUSED
        { return !mColorsListName.empty(); }

        bool isHaveIconColors() const noexcept2 A_WARN_UNUSED
        { return !mIconColorsListName.empty(); }

        std::string getColorsListName() const noexcept2 A_WARN_UNUSED
        { return mColorsListName; }

        std::string getIconColorsListName() const noexcept2 A_WARN_UNUSED
        { return mIconColorsListName; }

        const std::string replaceColors(std::string str,
                                        const ItemColor color)
                                        const A_WARN_UNUSED;

        void setPickupCursor(const std::string &cursor)
        { return setPickupCursor(Cursors::stringToCursor(cursor)); }

        void setPickupCursor(const CursorT &cursor) noexcept2
        { mPickupCursor = cursor; }

        CursorT getPickupCursor() const noexcept2 A_WARN_UNUSED
        { return mPickupCursor; }

        void setProtected(const bool b) noexcept2
        { mProtected = b; }

        bool isProtected() const noexcept2 A_WARN_UNUSED
        { return mProtected; }

        int getColorsSize() const noexcept2 A_WARN_UNUSED
        { return mColorsList != nullptr ? CAST_S32(mColorsList->size()) : 0; }

        int getIconColorsSize() const noexcept2 A_WARN_UNUSED
        {
            return mIconColorsList != nullptr ?
                CAST_S32(mIconColorsList->size()) : 0;
        }

        std::string getColorName(const ItemColor idx) const;
        std::string getColor(const ItemColor idx) const;

        std::string getIconColorName(const ItemColor idx) const;
        std::string getIconColor(const ItemColor idx) const;

        int mDrawBefore[10];
        int mDrawAfter[10];
        int mDrawPriority[10];

    private:
        static void setSpriteOrder(int *const ptr,
                                   const int direction,
                                   const int n,
                                   const int def = -1) A_NONNULL(1);

        SpriteDisplay mDisplay;     /**< Display info (like icon) */
        std::string mName;
        std::string mNameEn;
        std::string mDescription;   /**< Short description. */
        std::string mEffect;        /**< Description of effects. */
        std::string mUseButton;
        std::string mUseButton2;
        ItemDbTypeT mType;          /**< Item type. */
        int mWeight;                /**< Weight in grams. */
        int mView;                  /**< Item ID of how this item looks. */
        int mId;                    /**< Item ID */
        bool mIsRemoveSprites;
        // sprite, <itemfrom, itemto> [direction]
        SpriteToItemMap *mSpriteToItemReplaceMap[10];

        std::vector<SpriteToItemMap*> mSpriteToItemReplaceList;

        // Equipment related members.
        /** Attack type, in case of weapon.
         * See SpriteAction in spritedef.h for more info.
         * Attack action sub-types (bow, sword, ...) are defined in items.xml.
         */
        std::string mAttackAction;
        std::string mSkyAttackAction;
        std::string mWaterAttackAction;
        std::string mRideAttackAction;
        int mAttackRange;     /**< Attack range, will be zero if non weapon. */

        // Particle to be shown when weapon attacks
        std::string mMissileParticle;

        /** Maps gender to sprite filenames. */
        std::map <int, std::string> mAnimationFiles;

        /** Stores the names of sounds to be played at certain event. */
        std::map <ItemSoundEvent::Type, SoundInfoVect> mSounds;
        std::map <int, int> mTags;
        const std::map <ItemColor, ItemColorData> *mColorsList;
        const std::map <ItemColor, ItemColorData> *mIconColorsList;
        std::string mColorsListName;
        std::string mIconColorsListName;
        ItemColor mCardColor;
        int mHitEffectId;
        int mCriticalHitEffectId;
        int mMissEffectId;
        int maxFloorOffsetX;
        int maxFloorOffsetY;
        CursorT mPickupCursor;
        bool mProtected;
};

#endif  // RESOURCES_ITEMINFO_H