summaryrefslogtreecommitdiff
path: root/src/resources/itemdb.cpp
blob: 1457b6ddc3010d1cba82d4009ae6e9fa8948cf69 (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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *
 *  This file is part of The Mana 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/>.
 */

#include "resources/itemdb.h"

#include "log.h"

#include "net/net.h"

#include "resources/iteminfo.h"
#include "resources/resourcemanager.h"

#include "utils/dtor.h"
#include "utils/gettext.h"
#include "utils/stringutils.h"
#include "utils/xml.h"
#include "configuration.h"

#include <libxml/tree.h>

#include <cassert>

void setStatsList(const std::list<ItemStat> &stats)
{
    extraStats = stats;
}

static ItemType itemTypeFromString(const std::string &name, int id = 0)
{
    if      (name=="generic")           return ITEM_UNUSABLE;
    else if (name=="usable")            return ITEM_USABLE;
    else if (name=="equip-1hand")       return ITEM_EQUIPMENT_ONE_HAND_WEAPON;
    else if (name=="equip-2hand")       return ITEM_EQUIPMENT_TWO_HANDS_WEAPON;
    else if (name=="equip-torso")       return ITEM_EQUIPMENT_TORSO;
    else if (name=="equip-arms")        return ITEM_EQUIPMENT_ARMS;
    else if (name=="equip-head")        return ITEM_EQUIPMENT_HEAD;
    else if (name=="equip-legs")        return ITEM_EQUIPMENT_LEGS;
    else if (name=="equip-shield")      return ITEM_EQUIPMENT_SHIELD;
    else if (name=="equip-ring")        return ITEM_EQUIPMENT_RING;
    else if (name=="equip-charm")       return ITEM_EQUIPMENT_CHARM;
    else if (name=="equip-necklace")    return ITEM_EQUIPMENT_NECKLACE;
    else if (name=="equip-feet")        return ITEM_EQUIPMENT_FEET;
    else if (name=="equip-ammo")        return ITEM_EQUIPMENT_AMMO;
    else if (name=="racesprite")        return ITEM_SPRITE_RACE;
    else if (name=="hairsprite")        return ITEM_SPRITE_HAIR;
    else return ITEM_UNUSABLE;
}

/*
 * Common itemDB functions
 */

bool ItemDB::exists(int id)
{
    assert(mLoaded);

    ItemInfos::const_iterator i = mItemInfos.find(id);

    return i != mItemInfos.end();
}

const ItemInfo &ItemDB::get(int id)
{
    assert(mLoaded);

    ItemInfos::const_iterator i = mItemInfos.find(id);

    if (i == mItemInfos.end())
    {
        logger->log("ItemDB: Warning, unknown item ID# %d", id);
        return *mUnknown;
    }

    return *(i->second);
}

const ItemInfo &ItemDB::get(const std::string &name)
{
    assert(mLoaded);

    NamedItemInfos::const_iterator i = mNamedItemInfos.find(normalize(name));

    if (i == mNamedItemInfos.end())
    {
        if (!name.empty())
        {
            logger->log("ItemDB: Warning, unknown item name \"%s\"",
                        name.c_str());
        }
        return *mUnknown;
    }

    return *(i->second);
}

void ItemDB::loadSpriteRef(ItemInfo *itemInfo, xmlNodePtr node)
{
    std::string gender = XML::getProperty(node, "gender", "unisex");
    std::string filename = (const char*) node->xmlChildrenNode->content;

    if (gender == "male" || gender == "unisex")
    {
        itemInfo->setSprite(filename, GENDER_MALE);
    }
    if (gender == "female" || gender == "unisex")
    {
        itemInfo->setSprite(filename, GENDER_FEMALE);
    }
}

void ItemDB::loadSoundRef(ItemInfo *itemInfo, xmlNodePtr node)
{
    std::string event = XML::getProperty(node, "event", "");
    std::string filename = (const char*) node->xmlChildrenNode->content;

    if (event == "hit")
    {
        itemInfo->addSound(EQUIP_EVENT_HIT, filename);
    }
    else if (event == "strike")
    {
        itemInfo->addSound(EQUIP_EVENT_STRIKE, filename);
    }
    else
    {
        logger->log("ItemDB: Ignoring unknown sound event '%s'",
                event.c_str());
    }
}

void ItemDB::loadFloorSprite(SpriteDisplay *display, xmlNodePtr floorNode)
{
    for_each_xml_child_node(spriteNode, floorNode)
    {
        if (xmlStrEqual(spriteNode->name, BAD_CAST "sprite"))
        {
            SpriteReference *currentSprite = new SpriteReference;
            currentSprite->sprite = (const char*)spriteNode->xmlChildrenNode->content;
            currentSprite->variant = XML::getProperty(spriteNode, "variant", 0);
            display->sprites.push_back(currentSprite);
        }
        else if (xmlStrEqual(spriteNode->name, BAD_CAST "particlefx"))
        {
            std::string particlefx = (const char*)spriteNode->xmlChildrenNode->content;
            display->particles.push_back(particlefx);
        }
    }
}

void ItemDB::unload()
{
    logger->log("Unloading item database...");

    delete mUnknown;
    mUnknown = NULL;

    delete_all(mItemInfos);
    mItemInfos.clear();
    mNamedItemInfos.clear();
    mLoaded = false;
}

void ItemDB::loadCommonRef(ItemInfo *itemInfo, xmlNodePtr node)
{
        int id = XML::getProperty(node, "id", 0);

        if (!id)
        {
            logger->log("ItemDB: Invalid or missing item Id in "
                        ITEMS_DB_FILE "!");
            return;
        }
        else if (mItemInfos.find(id) != mItemInfos.end())
            logger->log("ItemDB: Redefinition of item Id %d", id);

        int view = XML::getProperty(node, "view", 0);

        std::string name = XML::getProperty(node, "name", "");
        std::string image = XML::getProperty(node, "image", "");
        std::string description = XML::getProperty(node, "description", "");
        std::string attackAction = XML::getProperty(node, "attack-action",
                                                    SpriteAction::INVALID);
        int attackRange = XML::getProperty(node, "attack-range", 0);
        std::string missileParticleFile = XML::getProperty(node,
                                                           "missile-particle",
                                                           "");
        int hitEffectId = XML::getProperty(node, "hit-effect-id",
                                           paths.getIntValue("hitEffectId"));
        int criticalEffectId = XML::getProperty(node, "critical-hit-effect-id",
                                      paths.getIntValue("criticalHitEffectId"));

        // Load Ta Item Type
        std::string typeStr = XML::getProperty(node, "type", "other");
        itemInfo->mType = itemTypeFromString(typeStr);

        int weight = XML::getProperty(node, "weight", 0);
        itemInfo->mWeight = weight > 0 ? weight : 0;

        SpriteDisplay display;
        display.image = image;

        itemInfo->mId = id;
        itemInfo->mName = name;
        itemInfo->mDescription = description;
        itemInfo->mView = view;
        itemInfo->mWeight = weight;
        itemInfo->mAttackAction = attackAction;
        itemInfo->mAttackRange = attackRange;
        itemInfo->setMissileParticleFile(missileParticleFile);
        itemInfo->setHitEffectId(hitEffectId);
        itemInfo->setCriticalHitEffectId(criticalEffectId);

        // Load <sprite>, <sound>, and <floor>
        for_each_xml_child_node(itemChild, node)
        {
            if (xmlStrEqual(itemChild->name, BAD_CAST "sprite"))
            {
                std::string attackParticle = XML::getProperty(
                    itemChild, "particle-effect", "");
                itemInfo->mParticle = attackParticle;

                loadSpriteRef(itemInfo, itemChild);
            }
            else if (xmlStrEqual(itemChild->name, BAD_CAST "sound"))
            {
                loadSoundRef(itemInfo, itemChild);
            }
            else if (xmlStrEqual(itemChild->name, BAD_CAST "floor"))
            {
                loadFloorSprite(&display, itemChild);
            }

        }

        // If the item has got a floor image, we bind the good reference.
        itemInfo->mDisplay = display;
}

void ItemDB::addItem(ItemInfo *itemInfo)
{
    std::string itemName = itemInfo->mName;
    itemInfo->mName = itemName.empty() ? _("unnamed") : itemName;
    mItemInfos[itemInfo->mId] = itemInfo;
    if (!itemName.empty())
    {
        std::string temp = normalize(itemName);

        NamedItemInfos::const_iterator itr = mNamedItemInfos.find(temp);
        if (itr == mNamedItemInfos.end())
            mNamedItemInfos[temp] = itemInfo;
        else
            logger->log("ItemDB: Duplicate name (%s) for item id %d found.",
                        temp.c_str(), itemInfo->mId);

    }
}

template <class T>
static void checkParameter(int id, const T param, const T errorValue)
{
    if (param == errorValue)
    {
        std::stringstream errMsg;
        errMsg << "ItemDB: Missing " << param << " attribute for item id "
               << id << "!";
        logger->log("%s", errMsg.str().c_str());
    }
}

void ItemDB::checkItemInfo(ItemInfo* itemInfo)
{
    int id = itemInfo->mId;
    if (!itemInfo->getAttackAction().empty())
        if (itemInfo->mAttackRange == 0)
            logger->log("ItemDB: Missing attack range from weapon %i!", id);

    if (id >= 0)
    {
        checkParameter(id, itemInfo->mName, std::string());
        checkParameter(id, itemInfo->mDescription, std::string());
        checkParameter(id, itemInfo->mDisplay.image, std::string());
        checkParameter(id, itemInfo->mWeight, 0);
    }
}

namespace TmwAthena {

// Description fields used by TaItemDB *itemInfo->mEffect.

static char const *const fields[][2] =
{
    { "attack",    N_("Attack %+d")    },
    { "defense",   N_("Defense %+d")   },
    { "hp",        N_("HP %+d")        },
    { "mp",        N_("MP %+d")        }
};

void TaItemDB::load()
{
    if (mLoaded)
        unload();

    logger->log("Initializing TmwAthena item database...");

    mUnknown = new TaItemInfo;
    mUnknown->mName = _("Unknown item");
    mUnknown->mDisplay = SpriteDisplay();
    std::string errFile = paths.getStringValue("spriteErrorFile");
    mUnknown->setSprite(errFile, GENDER_MALE);
    mUnknown->setSprite(errFile, GENDER_FEMALE);

    XML::Document doc(ITEMS_DB_FILE);
    xmlNodePtr rootNode = doc.rootNode();

    if (!rootNode || !xmlStrEqual(rootNode->name, BAD_CAST "items"))
    {
        logger->error("ItemDB: Error while loading " ITEMS_DB_FILE "!");
        return;
    }

    for_each_xml_child_node(node, rootNode)
    {
        if (!xmlStrEqual(node->name, BAD_CAST "item"))
            continue;

        TaItemInfo *itemInfo = new TaItemInfo;

        loadCommonRef(itemInfo, node);

        // Everything not unusable or usable is equippable by the Ta type system.
        itemInfo->mEquippable  = itemInfo->mType != ITEM_UNUSABLE
                                 && itemInfo->mType != ITEM_USABLE;

        // Load nano description
        std::vector<std::string> effect;
        for (int i = 0; i < int(sizeof(fields) / sizeof(fields[0])); ++i)
        {
            int value = XML::getProperty(node, fields[i][0], 0);
            if (!value)
                continue;
            effect.push_back(strprintf(gettext(fields[i][1]), value));
        }
        for (std::list<ItemStat>::iterator it = extraStats.begin();
                it != extraStats.end(); it++)
        {
            int value = XML::getProperty(node, it->mTag.c_str(), 0);
            if (!value)
                continue;
            effect.push_back(strprintf(it->mFormat.c_str(), value));
        }
        std::string temp = XML::getProperty(node, "effect", "");
        if (!temp.empty())
            effect.push_back(temp);

        itemInfo->mEffect = effect;

        checkItemInfo(itemInfo);

        addItem(itemInfo);
    }

    checkHairWeaponsRacesSpecialIds();

    mLoaded = true;
}

void TaItemDB::checkItemInfo(ItemInfo* itemInfo)
{
    ItemDB::checkItemInfo(itemInfo);

    // Check for unusable items?
    //checkParameter(id, itemInfo->mType, 0);
}

}; // namespace TmwAthena

namespace ManaServ {

static std::map<std::string, const char* > triggerTable;

static void initTriggerTable()
{
    if (triggerTable.empty())
    {
        // FIXME: This should ideally be softcoded via XML or similar.
        logger->log("Initializing ManaServ trigger table...");
        triggerTable["existence"]       = " when it is in the inventory";
        triggerTable["activation"]      = " upon activation";
        triggerTable["equip"]           = " upon successful equip";
        triggerTable["leave-inventory"] = " when it leaves the inventory";
        triggerTable["unequip"]         = " when it is unequipped";
        triggerTable["equip-change"]    = " when it changes the way it is equipped";
    }
}

void ManaServItemDB::load()
{
    if (mLoaded)
        unload();

    // Initialize the trigger table for effect descriptions
    initTriggerTable();

    logger->log("Initializing ManaServ item database...");

    mUnknown = new ManaServItemInfo;
    mUnknown->mName = _("Unknown item");
    mUnknown->mDisplay = SpriteDisplay();
    std::string errFile = paths.getStringValue("spriteErrorFile");
    mUnknown->setSprite(errFile, GENDER_MALE);
    mUnknown->setSprite(errFile, GENDER_FEMALE);

    XML::Document doc(ITEMS_DB_FILE);
    xmlNodePtr rootNode = doc.rootNode();

    if (!rootNode || !xmlStrEqual(rootNode->name, BAD_CAST "items"))
    {
        logger->log("ItemDB: Error while loading " ITEMS_DB_FILE "!");
        return;
    }

    for_each_xml_child_node(node, rootNode)
    {
        if (!xmlStrEqual(node->name, BAD_CAST "item"))
            continue;

        ManaServItemInfo *itemInfo = new ManaServItemInfo;

        loadCommonRef(itemInfo, node);

        // We default eqippable and activatable to false as their actual value will be set
        // within the <equip> and <effect> sub-nodes..
        itemInfo->mActivatable = false;
        itemInfo->mEquippable = false;

        // Load <equip>, and <effect> sub nodes.
        std::vector<std::string> effect;
        for_each_xml_child_node(itemChild, node)
        {
            if (xmlStrEqual(itemChild->name, BAD_CAST "equip"))
            {
                // The fact that there is a way to equip is enough.
                // Discard any details, but mark the item as equippable.
                itemInfo->mEquippable = true;
            }
            else if (xmlStrEqual(itemChild->name, BAD_CAST "effect"))
            {
                std::string trigger = XML::getProperty(
                        itemChild, "trigger", "");
                if (trigger.empty())
                {
                    logger->log("Found empty trigger effect label, skipping.");
                    continue;
                }

                if (trigger == "activation")
                    itemInfo->mActivatable = true;

                std::map<std::string, const char* >::const_iterator triggerLabel =
                        triggerTable.find(trigger);
                if (triggerLabel == triggerTable.end())
                {
                    logger->log("Warning: unknown trigger %s in item %d!",
                                trigger.c_str(), itemInfo->mId);
                    continue;
                }

                for_each_xml_child_node(effectChild, itemChild)
                {
                    if (xmlStrEqual(effectChild->name, BAD_CAST "modifier"))
                    {
                        std::string attribute = XML::getProperty(
                                effectChild, "attribute", "");
                        double value = XML::getFloatProperty(
                                effectChild, "value", 0.0);
                        int duration = XML::getProperty(
                                effectChild, "duration", 0);
                        if (attribute.empty() || !value)
                        {
                            logger->log("Warning: incomplete modifier definition, skipping.");
                            continue;
                        }
                        std::list<ItemStat>::const_iterator
                                it = extraStats.begin(),
                                it_end = extraStats.end();
                        while (it != it_end && !(*it == attribute))
                            ++it;
                        if (it == extraStats.end())
                        {
                            logger->log("Warning: unknown modifier tag %s, skipping.", attribute.c_str());
                            continue;
                        }
                        effect.push_back(
                                strprintf(strprintf(
                                        duration ?
                                        strprintf("%%s%%s. This effect lasts %d ticks.", duration).c_str()
                                        : "%s%s.", it->mFormat.c_str(), triggerLabel->second).c_str(), value));
                    }
                    else if (xmlStrEqual(effectChild->name, BAD_CAST "modifier"))
                        effect.push_back(strprintf("Provides an autoattack%s.",
                                                   triggerLabel->second));
                    else if (xmlStrEqual(effectChild->name, BAD_CAST "consumes"))
                        effect.push_back(strprintf("This will be consumed%s.",
                                                   triggerLabel->second));
                    else if (xmlStrEqual(effectChild->name, BAD_CAST "label"))
                        effect.push_back(
                                (const char*)effectChild->xmlChildrenNode->content);
                }
            }
            // Set Item Type based on subnodes info
            // TODO: Improve it once the itemTypes are loaded through xml
            itemInfo->mType = ITEM_UNUSABLE;
            if (itemInfo->mActivatable)
                itemInfo->mType = ITEM_USABLE;
            else if (itemInfo->mEquippable)
                itemInfo->mType = ITEM_EQUIPMENT_TORSO;
        } // end for_each_xml_child_node(itemChild, node)

        itemInfo->mEffect = effect;

        checkItemInfo(itemInfo);

        addItem(itemInfo);
    }

    mLoaded = true;
}

void ManaServItemDB::checkItemInfo(ItemInfo* itemInfo)
{
    ItemDB::checkItemInfo(itemInfo);

    // Add specific Manaserv checks here
}

}; // namespace ManaServ