Mercurial > molko

annotate librpg/rpg/item.h @ 148:c577c15df07f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: split libraries, closes #2496
author David Demelier <markand@malikania.fr>
date Thu, 15 Oct 2020 10:32:18 +0200
parents libcore/core/item.h@b386d25832c8
children ce789473567e
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 * item.h -- inventory 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_ITEM_H
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_ITEM_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 item.h
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Inventory 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 #include <stdbool.h>
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
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 * \brief Maximum count of an item into a stack.
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 #define ITEM_STACK_MAX 64
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 struct character;
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 struct texture;
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 /**
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 * \brief Inventory items.
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 struct item {
147
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
41 const char *name; /*!< (+) Name of item. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
42 const char *summary; /*!< (+) Summary description. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
43 struct texture *icon; /*!< (+&) Icon to show. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
44 unsigned int stackable; /*!< (+) Stack count allowed. */
85
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 /**
147
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
47 * (+) Execute the action for this character.
85
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 void (*exec)(const struct item *, struct character *);
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 /**
147
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
52 * (+?) Tells if the item can be used in this context.
85
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 */
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 bool (*allowed)(const struct item *, const struct character *);
34e91215ec5a core: implement basic parts of inventories, closes #2483
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 };
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 #endif /* !MOLKO_ITEM_H */