-
-
Notifications
You must be signed in to change notification settings - Fork 32
/
hu_msg.h
91 lines (75 loc) · 2.34 KB
/
hu_msg.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/**
* @file hu_msg.h
* Important state change messages.
*
* @authors Copyright © 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2006-2012 Daniel Swanson <danij@dengine.net>
* @authors Copyright © 1993-1996 by id Software, Inc.
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#ifndef LIBCOMMON_HUD_MESSAGE_H
#define LIBCOMMON_HUD_MESSAGE_H
#include "common.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
MSG_CANCEL = -1,
MSG_NO,
MSG_YES,
NUM_MESSAGE_RESPONSES
} msgresponse_t;
typedef int (C_DECL *msgfunc_t) (msgresponse_t response, int userValue, void* userPointer);
typedef enum {
MSG_ANYKEY,
MSG_YESNO,
NUM_MESSAGE_TYPES
} msgtype_t;
/**
* Called during the PreInit of each game during start up.
* Register Cvars and CCmds for the important messages.
*/
void Hu_MsgRegister(void);
/**
* Called during init.
*/
void Hu_MsgInit(void);
/**
* Called during engine shutdown.
*/
void Hu_MsgShutdown(void);
/**
* Updates on Game Tick.
*/
void Hu_MsgTicker(void);
/**
* If an "any key" message is active, respond to the event.
*/
int Hu_MsgResponder(event_t* ev);
/**
* Draw any active message.
*/
void Hu_MsgDrawer(void);
boolean Hu_IsMessageActive(void);
boolean Hu_IsMessageActiveWithCallback(msgfunc_t callback);
/**
* Begin a new game state message/question.
*/
void Hu_MsgStart(msgtype_t type, const char* msg, msgfunc_t callback, int userValue, void* userPointer);
#ifdef __cplusplus
} // extern "C"
#endif
#endif /// LIBCOMMON_HUD_MESSAGE_H