Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: 27e6028bd37c73d6cc2d428a60aa0ef7fe54a98e (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
176
177
178
179
180
181
182
183
184
185
/*
   core/item.h
   This file is part of the Osirion project and is distributed under
   the terms of the GNU General Public License version 2
*/

#ifndef __INCLUDED_CORE_ITEM_H__
#define __INCLUDED_CORE_ITEM_H__

#include "core/info.h"

namespace core
{

/**
 * @brief an item in the inventory of an entity
 * The info record represents the type of the item
 */
class Item
{
public:
	/**
	 * @brief item flags indicating special properties
	 * Tradeable		(reserved)
	 * Unique		indicates a unique item
	 * Unrestricted		can be sold everywhere (e.g. cargo)
	 * Mountable		indicate the item can be mounted in a slot
	 * Mounted		indicates the item is mounted in a slot
	 * */
	enum Flags {Tradeable = 1, Unique = 2, Unrestricted = 4, Mountable = 8, Mounted = 16};
	
	Item(const Info *info);
	
	~Item();
	
	/* ---- inspectors --------------------------------------------- */
	
	/**
	 * @brief returns the item id
	 * */
	inline unsigned int id() const { return item_id; }
	
	/**
	 * @brief associated amount
	 */
	 inline long amount() const { return item_amount; }

	/**
	 * @brief information record
	 */
	inline const Info *info() const { return item_info; }
	 
	 /**
	 * @brief price
	 */
	inline const long price() const {
		return item_price;
	}
	
	/**
	 * @brief server timestamp
	 */
	inline const unsigned long timestamp() const {
		return item_timestamp;
	}
	
	/**
	 * @brief item flags
	 */
	inline const unsigned int flags() const {
		return item_flags;
	}
	
	/**
	 * @brief returns true of a flag is set
	 */
	inline const bool has_flag(const Flags flag) const {
		return ((item_flags & (unsigned int) flag) == (unsigned int) flag);
	}
	
	/**
	 * @brief returns true if the Unique flag is set
	 */
	inline const bool unique() const {
		return ((item_flags & (unsigned int) Unique) == (unsigned int) Unique);
	}
	
	/**
	 * @brief returns true if the Unrestricted flag is set
	 */
	inline const bool unrestricted() const {
		return ((item_flags & (unsigned int) Unrestricted) == (unsigned int) Unrestricted);
	}
	
	/**
	 * @brief return true if the dirty flag is set
	 * */
	inline const bool dirty() const {
		return item_dirty;
	}
	
	/* ---- mutators ----------------------------------------------- */
	
	/**
	 * @brief set item id
	 * This should never be called from within the game module,
	 * it is used by Inventory to keep track of unique items
	 */
	void set_id(const unsigned int id);
	
	/**
	 * @brief set item info
	 * This should never be called from within the game module,
	 * it essentially changes the item type and is used by NetConnection
	 * for inventory householding.
	 */
	void set_info(const Info *info);

	/**
	 * @brief set associated amount
	 */
	void set_amount(const long amount);
	 
	/**
	 * @brief increase associated amount
	 */
	void inc_amount(const long amount);
	 
	/**
	 * @brief decrease associated amount
	 */
	void dec_amount(const long amount);
	 
	/**
	 * @brief set associated price
	 */
	void set_price(const long price);
	
	/**
	 * @brief set all item flags
	 */
	void set_flags(const unsigned int flags);
	
	/**
	 * @brief set item flag
	 */
	void set_flag(Flags flag);

	/**
	 * @brief unset item flag
	 */
	void unset_flag(Flags flag);
	
	/**
	 * @brief set the dirty flag
	 * */
	inline void set_dirty(const bool dirty = true) {
		item_dirty = dirty;
	}
	
	/* ---- serializers -------------------------------------------- */
	 
	void serialize_server_update(std::ostream & os) const;

	void receive_server_update(std::istream &is);
	
private:
	void set_timestamp(const unsigned long timestamp);
	
	const Info		*item_info;
	long			item_price;
	long 			item_amount;
	
	unsigned long		item_timestamp;
	
	unsigned int		item_flags;
	
	bool			item_dirty;
	
	unsigned int		item_id;
};

} // namespace core

#endif // __INCLUDED_CORE_ITEM_H__