Mercurial > molko

comparison src/core/inhibit.h @ 74:4991bf5f2343

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: implement inhibit system, closes #2468 @1h
author David Demelier <markand@malikania.fr>
date Fri, 31 Jan 2020 13:47:49 +0100
parents
children
comparison
equal deleted inserted replaced
73:b49d8475a611 74:4991bf5f2343
1 /*
2 * inhibit.h -- disable specific game behavior
3 *
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
5 *
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19 #ifndef MOLKO_INHIBIT_H
20 #define MOLKO_INHIBIT_H
21
22 /**
23 * \file inhibit.h
24 * \brief Disable specific game behavior.
25 */
26
27 struct action;
28
29 /**
30 * \brief Game inhibition.
31 *
32 * This enum is used to alter the game behavior.
33 */
34 enum inhibit {
35 /**
36 * Nothing.
37 */
38 INHIBIT_NONE,
39
40 /**
41 * Disable input handling in current state.
42 */
43 INHIBIT_STATE_INPUT = (1 << 0),
44
45 /**
46 * Disable current state updates.
47 */
48 INHIBIT_STATE_UPDATE = (1 << 1),
49
50 /**
51 * Disable current state rendering.
52 */
53 INHIBIT_STATE_DRAW = (1 << 2)
54 };
55
56 /**
57 * Create an action to inhibit the system.
58 *
59 * The mode will replace the actual inhibit modes rather than adding new flags.
60 *
61 * \pre a != NULL
62 * \param mode the new mode
63 * \param a the action to fill
64 */
65 void
66 inhibit_action(enum inhibit mode, struct action *a);
67
68 #endif /* !MOLKO_INHIBIT_H */