Mercurial > molko

annotate src/core/inventory.h @ 112:40f22a8188d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
image: set dimensions
author David Demelier <markand@malikania.fr>
date Sun, 12 Apr 2020 16:55:26 +0200
parents d3bc14c1e243
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
85
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * inventory.h -- inventory of items
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_INVENTORY_H
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_INVENTORY_H
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file inventory.h
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Inventory of items.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 * \brief Maximum number of rows.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 #define INVENTORY_ROWS_MAX 3
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * \brief Maximum number of columns.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 #define INVENTORY_COLS_MAX 10
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 struct item;
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 * \brief Inventory slot.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 * This structure describe a 'cell' into the inventory. It references a item
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 * and has a given amount of it.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 struct inventory_slot {
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 struct item *item; /*!< (RO, ref) Pointer to the item. */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 unsigned int amount; /*!< (RO) Number of items in this slot. */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 };
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * \brief Inventory structure.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 struct inventory {
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 * (RW)
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 * Grid of objects.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 struct inventory_slot items[INVENTORY_ROWS_MAX][INVENTORY_COLS_MAX];
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 };
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 * Try to push as much as possible the given item.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 * \pre iv != NULL
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 * \pre item != NULL
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 * \param iv the inventory
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 * \param item the item to reference
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 * \param amount the desired amount
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 * \return 0 if all items were pushed or the number left otherwise
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 unsigned int
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 inventory_push(struct inventory *iv, struct item *item, unsigned int amount);
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 /**
110
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
76 * Sort the inventory.
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
77 *
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
78 * \pre iv != NULL
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
79 * \pre item != NULL
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
80 * \param iv the inventory
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
81 */
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
82 void
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
83 inventory_sort(struct inventory *iv);
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
84
d3bc14c1e243 inventory: add sorting algorithms
David Demelier <markand@malikania.fr>
parents: 85
diff changeset
85 /**
85
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 * Clears the inventory.
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 *
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 * \pre iv != NULL
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 * \param iv the inventory
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 void
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 inventory_clear(struct inventory *iv);
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
93
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 #endif /* !MOLKO_INVENTORY_H */