aboutsummaryrefslogtreecommitdiff
path: root/engines/sherlock/inventory.h
blob: 019f5ed6c97fcc62778f1be7691e9e4bbd0caff0 (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
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
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 (at your option) 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef SHERLOCK_INVENTORY_H
#define SHERLOCK_INVENTORY_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/str-array.h"
#include "sherlock/objects.h"
#include "sherlock/resources.h"
#include "sherlock/saveload.h"

namespace Sherlock {

#define MAX_VISIBLE_INVENTORY 6

enum InvMode {
	INVMODE_EXIT = 0,
	INVMODE_LOOK = 1,
	INVMODE_USE = 2,
	INVMODE_GIVE = 3,
	INVMODE_FIRST = 4,
	INVMODE_PREVIOUS = 5,
	INVMODE_NEXT = 6,
	INVMODE_LAST = 7,
	INVMODE_INVALID = 8,
	INVMODE_USE55 = 255
};

enum InvNewMode {
	PLAIN_INVENTORY = 0, LOOK_INVENTORY_MODE = 1, USE_INVENTORY_MODE = 2,
	GIVE_INVENTORY_MODE = 3, INVENTORY_DONT_DISPLAY = 128
};

enum InvSlamMode { SLAM_DONT_DISPLAY, SLAM_DISPLAY = 1, SLAM_SECONDARY_BUFFER };


struct InventoryItem {
	int _requiredFlag;
	Common::String _name;
	Common::String _description;
	Common::String _examine;
	int _lookFlag;

	// Rose Tattoo fields
	int _requiredFlag1;
	UseType _verb;

	InventoryItem() : _requiredFlag(0), _lookFlag(0), _requiredFlag1(0) {}
	InventoryItem(int requiredFlag, const Common::String &name,
		const Common::String &description, const Common::String &examine);

	/**
	 * Synchronize the data for an inventory item
	 */
	void synchronize(Serializer &s);
};

class Inventory : public Common::Array<InventoryItem> {
private:
	SherlockEngine *_vm;
	Common::StringArray _names;

	/**
	 * Copy the passed object into the inventory
	 */
	void copyToInventory(Object &obj);
public:
	ImageFile *_invShapes[MAX_VISIBLE_INVENTORY];
	bool _invGraphicsLoaded;
	InvMode _invMode;
	int _invIndex;
	int _holdings;		// Used to hold number of visible items in active inventory.
						// Since Inventory array also contains some special hidden items
	/**
	 * Free any loaded inventory graphics
	 */
	void freeGraphics();
public:
	Inventory(SherlockEngine *vm);
	~Inventory();

	/**
	 * Free inventory data
	 */
	void freeInv();

	/**
	 * Load the list of names the inventory items correspond to, if not already loaded,
	 * and then calls loadGraphics to load the associated graphics
	 */
	void loadInv();

	/**
	 * Load the list of names of graphics for the inventory
	 */
	void loadGraphics();

	/**
	 * Searches through the list of names that correspond to the inventory items
	 * and returns the number that matches the passed name
	 */
	int findInv(const Common::String &name);

	/**
	 * Display the character's inventory. The slamIt parameter specifies:
	 */
	void putInv(InvSlamMode slamIt);

	/**
	 * Put the game into inventory mode and open the interface window.
	 */
	void drawInventory(InvNewMode flag);

	/**
	 * Prints the line of inventory commands at the top of an inventory window with
	 * the correct highlighting
	 */
	void invCommands(bool slamIt);

	/**
	 * Set the highlighting color of a given inventory item
	 */
	void highlight(int index, byte color);

	/**
	 * Support method for refreshing the display of the inventory
	 */
	void refreshInv();

	/**
	 * Adds a shape from the scene to the player's inventory
	 */
	int putNameInInventory(const Common::String &name);

	/**
	 * Moves a specified item into the player's inventory If the item has a *PICKUP* use action,
	 * then the item in the use action are added to the inventory.
	 */
	int putItemInInventory(Object &obj);

	/**
	 * Deletes a specified item from the player's inventory
	 */
	int deleteItemFromInventory(const Common::String &name);

	/**
	 * Synchronize the data for a savegame
	 */
	void synchronize(Serializer &s);
};

} // End of namespace Sherlock

#endif