annotate examples/example-action/dialog.h @ 515:2e05c1804b25

core: doxygenize sprite
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 11:02:48 +0100
parents f14b8290b3ce
children 88e9bd420a28
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
484
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * dialog.h -- convenient message wrapper
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MLK_EXAMPLE_ACTION_DIALOG_H
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MLK_EXAMPLE_ACTION_DIALOG_H
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <mlk/core/action.h>
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include <mlk/rpg/message.h>
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct dialog {
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 /* public */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 void *data;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 void (*response)(struct dialog *, unsigned int);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 struct message msg;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /* private */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 struct mlk_action action;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 };
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 struct mlk_action *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 dialog_init(struct dialog *);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 #endif /* !MLK_EXAMPLE_ACTION_DIALOG_H */