Mercurial > molko

annotate libmlk-rpg/mlk/rpg/walksprite.h @ 462:5729efd23286

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: core -> mlk_core
author David Demelier <markand@malikania.fr>
date Mon, 27 Feb 2023 09:52:55 +0100
parents 773a082f0b91
children 91ce23a36143
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * walksprite.h -- sprite designed for walking entities
3996f873a54b core: implement walksprite, closes #2455
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>
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
3996f873a54b core: implement walksprite, closes #2455
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_WALKSPRITE_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_RPG_WALKSPRITE_H
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
431
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
22 #include <mlk/core/core.h>
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
23
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 struct sprite;
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 /**
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 * \brief Sprite designed for walking entities.
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 * This structure works with sprite images that are defined as using the
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * following conventions:
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * ```
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * 7 0 1
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * ↖ ↑ ↗
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 * 6 ← → 2
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * ↙ ↓ ↘
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 * 5 4 3
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 * ```
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 * Where numbers define row in the sprite according to the character
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 * orientation. In other terms, your image sprite should look like this:
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 * ```
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 * row columns in your image
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 * ---|---------------------
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * 0 | ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * 1 | ↗↗↗↗↗↗↗↗↗↗↗↗↗↗↗↗↗↗↗↗
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * 2 | →→→→→→→→→→→→→→→→→→→→
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 * 3 | ↘↘↘↘↘↘↘↘↘↘↘↘↘↘↘↘↘↘↘↘
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * 4 | ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * 5 | ↙↙↙↙↙↙↙↙↙↙↙↙↙↙↙↙↙↙↙↙
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 * 6 | ←←←←←←←←←←←←←←←←←←←←
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 * 7 | ↖↖↖↖↖↖↖↖↖↖↖↖↖↖↖↖↖↖↖↖
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 * ```
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 */
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 struct walksprite {
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
57 struct sprite *sprite;
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
58 unsigned int delay;
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
59 unsigned int index;
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
60 unsigned int elapsed;
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 };
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
462
5729efd23286 core: core -> mlk_core
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
63 MLK_CORE_BEGIN_DECLS
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
64
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
66 walksprite_init(struct walksprite *, struct sprite *, unsigned int);
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents: 197
diff changeset
68 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
69 walksprite_reset(struct walksprite *);
230
86b71e1f9dd5 rpg: add movements in battle
David Demelier <markand@malikania.fr>
parents: 197
diff changeset
70
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
72 walksprite_update(struct walksprite *, unsigned int);
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 void
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
75 walksprite_draw(const struct walksprite *, unsigned int, int, int);
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
462
5729efd23286 core: core -> mlk_core
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
77 MLK_CORE_END_DECLS
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
78
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
79 #endif /* !MLK_RPG_WALKSPRITE_H */