annotate libadventure/adventure/state/mainmenu.h @ 162:629f55f3961e

core: rework states
author David Demelier <markand@malikania.fr>
date Sun, 18 Oct 2020 12:01:59 +0200
parents libadventure/adventure/mainmenu_state.h@789b23e01f52
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
2 * mainmenu.h -- game main menu
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
19 #ifndef MOLKO_STATE_MAINMENU_H
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
20 #define MOLKO_STATE_MAINMENU_H
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
23 * \file mainmenu.h
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Game main menu.
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 /**
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
28 * Create a state about the main game menu.
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
29 *
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
30 * \pre state != NULL
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
31 * \param state the state to initialize
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
32 * \post state->data is set internal data
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
33 * \post state->handle is set
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
34 * \post state->draw is set
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
35 * \post state->update is set
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
36 * \post state->finish is set
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 */
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
38 void
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
39 mainmenu_state(struct state *state);
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
41 #endif /* !MOLKO_STATE_PANIC_H */