annotate src/libmlk-rpg/rpg/battle-entity-state.h @ 383:b944cd41e8f9

rpg: do the same for battle entities
author David Demelier <markand@malikania.fr>
date Sun, 13 Feb 2022 11:13:17 +0100
parents 460c78706989
children 8f59201dc76b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * battle-entity-state.h -- abstract battle entity state
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
378
460c78706989 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 366
diff changeset
4 * Copyright (c) 2020-2022 David Demelier <markand@malikania.fr>
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
86b71e1f9dd5 rpg: add movements in battle
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_BATTLE_ENTITY_STATE_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_RPG_BATTLE_ENTITY_STATE_H
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 254
diff changeset
22 #include <core/core.h>
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 254
diff changeset
23
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 struct battle_entity;
254
6367b976112d rpg: merge battle state switchers to remove number of files
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
25 struct sprite;
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
254
6367b976112d rpg: merge battle state switchers to remove number of files
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
27 struct battle_entity_state {
6367b976112d rpg: merge battle state switchers to remove number of files
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
28 void *data;
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
29 int (*update)(struct battle_entity_state *, struct battle_entity *, unsigned int);
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
30 void (*draw)(const struct battle_entity_state *, const struct battle_entity *);
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
31 void (*finish)(struct battle_entity_state *, struct battle_entity *);
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 };
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 254
diff changeset
34 CORE_BEGIN_DECLS
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 254
diff changeset
35
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
36 int
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
37 battle_entity_state_update(struct battle_entity_state *, struct battle_entity *, unsigned int);
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
40 battle_entity_state_draw(const struct battle_entity_state *, const struct battle_entity *);
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
43 battle_entity_state_finish(struct battle_entity_state *, struct battle_entity *);
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 254
diff changeset
45 CORE_END_DECLS
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 254
diff changeset
46
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
47 #endif /* !MLK_RPG_BATTLE_ENTITY_STATE_H */