annotate libmlk-rpg/mlk/rpg/battle-state-item.h @ 564:e91f37da2992

core: doxygenize window
author David Demelier <markand@malikania.fr>
date Wed, 08 Mar 2023 20:09:21 +0100
parents 773a082f0b91
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
382
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * battle-state-item.h -- battle state (using item)
43d155668a55 rpg: expose battle state functions
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>
382
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MLK_RPG_BATTLE_STATE_ITEM_H
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MLK_RPG_BATTLE_STATE_ITEM_H
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
434
4e78f045e8c0 rpg: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 384
diff changeset
22 #include <mlk/rpg/battle-message.h>
382
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 struct battle;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 struct battle_entity;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct inventory_slot;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 enum battle_state_item_status {
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 BATTLE_STATE_ITEM_ADVANCING,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 BATTLE_STATE_ITEM_MESSAGE,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 BATTLE_STATE_ITEM_RETURNING
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 };
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 struct battle_state_item {
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 enum battle_state_item_status status;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 struct battle_message msg;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 struct battle_entity *source;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 struct battle_entity *target;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 struct inventory_slot *slot;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 int origin_x;
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 };
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 void
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 battle_state_item_init(struct battle_state_item *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 struct battle *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 struct battle_entity *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 struct battle_entity *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 struct inventory_slot *);
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 int
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 battle_state_item_update(struct battle_state_item *, struct battle *, unsigned int);
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 void
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 battle_state_item_draw(struct battle_state_item *);
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 void
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 battle_state_item(struct battle *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 struct battle_entity *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 struct battle_entity *,
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 struct inventory_slot *);
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
43d155668a55 rpg: expose battle state functions
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 #endif /* !MLK_RPG_BATTLE_STATE_ITEM_H */