annotate libcore/core/inhibit.h @ 197:852d0b7817ce

rpg: map, extreme cleanup, closes #2508 @4h
author David Demelier <markand@malikania.fr>
date Mon, 09 Nov 2020 10:37:36 +0100
parents f6497ec74b49
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
74
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * inhibit.h -- disable specific game behavior
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_INHIBIT_H
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_INHIBIT_H
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file inhibit.h
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Disable specific game behavior.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 struct action;
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 /**
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * \brief Game inhibition.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 *
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * This enum is used to alter the game behavior.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 enum inhibit {
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 /**
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * Nothing.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 INHIBIT_NONE,
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 /**
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 * Disable input handling in current state.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 INHIBIT_STATE_INPUT = (1 << 0),
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 /**
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * Disable current state updates.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 INHIBIT_STATE_UPDATE = (1 << 1),
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 /**
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * Disable current state rendering.
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 */
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 INHIBIT_STATE_DRAW = (1 << 2)
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 };
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 #endif /* !MOLKO_INHIBIT_H */