|
253
|
1 # Module: inhibit |
|
|
2 |
|
|
3 Synopsis |
|
|
4 |
|
|
5 ```c |
|
|
6 #include <core/inhibit.h> |
|
|
7 ``` |
|
|
8 |
|
|
9 Inhibit some mechanism of the game loop. |
|
|
10 |
|
|
11 This module is mostly use only for the [game](game.md) module. |
|
|
12 |
|
|
13 !!! hint |
|
|
14 This module should be used as last resort because it may introduce bugs if |
|
|
15 you forget to reset inhibit. In most of the cases you would want to use |
|
|
16 [actions](action.md) and block a state until it's complete. |
|
|
17 |
|
|
18 ## Enums |
|
|
19 |
|
|
20 ### inhibit |
|
|
21 |
|
|
22 This enumeration contains values than can be OR'ed and stored in |
|
|
23 [game.inhibit](game.md#inhibit) variable. |
|
|
24 |
|
|
25 | Enumerator | Description | |
|
|
26 |------------------------|-----------------------| |
|
|
27 | `INHIBIT_NONE` | Disable nothing. | |
|
|
28 | `INHIBIT_STATE_INPUT` | Disable every events. | |
|
|
29 | `INHIBIT_STATE_UPDATE` | Disable update. | |
|
|
30 | `INHIBIT_STATE_DRAW` | Disable draw. | |
|
|
31 |
|
|
32 !!! caution |
|
|
33 Use `INHIBIT_STATE_DRAW` with care because not re-rendering the screen can |
|
|
34 cause artifacts. |
