annotate libmlk-rpg/mlk/rpg/equipment.h @ 567:90302d95cd33

core: doxygenize util
author David Demelier <markand@malikania.fr>
date Wed, 08 Mar 2023 21:13:07 +0100
parents 6e8f6640e05b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * equipment.h -- character equipment
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 434
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
19 #ifndef MLK_RPG_EQUIPMENT_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_RPG_EQUIPMENT_H
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 struct character;
472
bc5483849614 core: texture -> mlk_texture
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
23 struct mlk_texture;
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 enum equipment_type {
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 /* Attack weapons. */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
27 EQUIPMENT_TYPE_AXE,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
28 EQUIPMENT_TYPE_BOW,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
29 EQUIPMENT_TYPE_CROSSBOW,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
30 EQUIPMENT_TYPE_DAGGER,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
31 EQUIPMENT_TYPE_HAMMER,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
32 EQUIPMENT_TYPE_SPIKE,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
33 EQUIPMENT_TYPE_SWORD,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
34 EQUIPMENT_TYPE_WAND,
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 /* Defense equipment. */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
37 EQUIPMENT_TYPE_GLOVES,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
38 EQUIPMENT_TYPE_HELMET,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
39 EQUIPMENT_TYPE_SHIELD,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
40 EQUIPMENT_TYPE_TOP,
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
41 EQUIPMENT_TYPE_TROUSERS,
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 };
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 struct equipment {
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
45 const char *name;
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
46 const char *description;
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
47 unsigned int price;
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
48 enum equipment_type type;
472
bc5483849614 core: texture -> mlk_texture
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
49 struct mlk_texture *icon;
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
51 void (*equip)(const struct equipment *, struct character *);
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 };
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 472
diff changeset
54 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 472
diff changeset
55 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 472
diff changeset
56 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
57
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
58 int
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
59 equipment_ok(const struct equipment *);
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
62 equipment_equip(const struct equipment *, struct character *);
235
fb304a94a05c rpg: prepare equipment
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 472
diff changeset
64 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 472
diff changeset
65 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 472
diff changeset
66 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
67
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
68 #endif /* !MLK_RPG_EQUIPMENT_H */