summaryrefslogtreecommitdiffstats
path: root/src/game-server/inventory.h
blob: 24d469426fd5c5e77a9610ecd3b48723d8ac6395 (plain)
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
/*
 *  The Mana Server
 *  Copyright (C) 2004-2010  The Mana World Development Team
 *
 *  This file is part of The Mana Server.
 *
 *  The Mana Server 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 Server 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 Server.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef INVENTORY_H
#define INVENTORY_H

#include "game-server/character.h"
#include "net/messageout.h"

class ItemClass;

/**
 * Class used to handle Character possessions and prepare outgoing messages.
 */
class Inventory
{
    public:

        /**
         * Creates a view on the possessions of a character.
         */
        Inventory(Character *);

        /**
         * Commits delayed changes if applicable.
         * Sends the update message to the client.
         */
        ~Inventory()
        {}

        /**
         * Sends complete inventory status to the client.
         */
        void sendFull() const;

        /**
         * Ensures the inventory is sane and apply equipment modifiers.
         * Should be run only once and the very first time.
         */
        void initialize();

        /**
         * Equips item from given inventory slot.
         * @param slot The slot in which the target item is in.
         * @param override Whether this item can unequip other items to equip
         *            itself. If true, items that are unequipped will be
         *            attempted to be reequipped, but with override disabled.
         * @returns whether the item could be equipped.
         */
        bool equip(int slot, bool override = true);

        /**
         * Unequips item from given equipment slot.
         * @param it Starting iterator. When the only parameter, also extracts
         *           slot number from it.
         *           Used so that when we already have an iterator to the first
         *           occurence from a previous operation we can start from
         *           there.
         * @returns Whether it was unequipped.
         */
        bool unequip(EquipData::iterator it);
        bool unequip(unsigned int slot, EquipData::iterator *itp = 0);

        /**
         * Inserts some items into the inventory.
         * @return number of items not inserted (to be dropped on floor?).
         */
        unsigned int insert(unsigned int itemId, unsigned int amount);

        /**
         * Removes some items from inventory.
         * @return number of items not removed.
         */
        unsigned int remove(unsigned int itemId, unsigned int amount);

        /**
         * Moves some items from the first slot to the second one.
         * @returns number of items not moved.
         */
        unsigned int move(unsigned int slot1, unsigned int slot2,
                          unsigned int amount);

        /**
         * Removes some items from inventory.
         * @return number of items not removed.
         */
        unsigned int removeFromSlot(unsigned int slot, unsigned int amount);

        /**
         * Counts number of items with given ID.
         */
        unsigned int count(unsigned int itemId) const;

        /**
         * Gets the ID of the items in a given slot.
         */
        unsigned int getItem(unsigned int slot) const;

    private:
        /**
         * Check the inventory is within the slot limit and capacity.
         * Forcibly delete items from the end if it is not.
         * @todo Drop items instead?
         */
        void checkInventorySize();

        /**
         * Helper function for equip() when computing changes to equipment
         * When newCount is 0, the item is being unequipped.
         */
        // inventory slot -> {equip slots}
        typedef std::multimap<unsigned int, unsigned short> IdSlotMap;
        void equip_sub(unsigned int newCount, IdSlotMap::const_iterator &it);

        /**
         * Changes equipment and adjusts character attributes.
         */
        void updateEquipmentTrigger(unsigned int oldId, unsigned int itemId);
        void updateEquipmentTrigger(ItemClass *oldI, ItemClass *newI);

        Possessions *mPoss; /**< Pointer to the modified possessions. */

        Character *mCharacter; /**< Character to notify. */
};

#endif