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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/*
* Copyright (C) Volition, Inc. 1999. All rights reserved.
*
* All source code herein is the property of Volition, Inc. You may not sell
* or otherwise commercially exploit the source or things you created based on the
* source.
*
*/
#ifndef _HUDCONFIG_H
#define _HUDCONFIG_H
#include "hud/hud.h"
#include "ui/ui.h"
class player;
class ship;
struct ai_info;
#define HUD_COLOR_GREEN 0
#define HUD_COLOR_BLUE 1
#define HUD_COLOR_AMBER 2
#define HUD_COLOR_SIZE 3 // Number of default colors. Keep this up to date.
// specify the max distance that the radar should detect objects
// Index in Radar_ranges[] array to get values
#define RR_MAX_RANGES 3 // keep up to date
#define RR_SHORT 0
#define RR_LONG 1
#define RR_INFINITY 2
extern float Radar_ranges[RR_MAX_RANGES];
extern const char *Radar_range_text(int range_num);
#define RP_SHOW_DEBRIS (1<<0)
#define RP_SHOW_FRIENDLY_MISSILES (1<<1)
#define RP_SHOW_HOSTILE_MISSILES (1<<2)
#define RP_DEFAULT ( RP_SHOW_DEBRIS | RP_SHOW_FRIENDLY_MISSILES | RP_SHOW_HOSTILE_MISSILES )
/*!
* @brief Vector for storing the filenames of hud preset files
* @note main definition in hudconfig.cpp
*/
extern SCP_vector<SCP_string> HC_preset_filenames;
extern int HUD_observer_default_flags;
extern int HUD_observer_default_flags2;
extern int HUD_default_popup_mask;
extern int HUD_default_popup_mask2;
extern int HUD_config_default_flags;
extern int HUD_config_default_flags2;
/**
* @brief Contains core HUD configuration data
* @note Is not default init'd. Assumes new player, PLR, or CSG reads will correctly set data.
*/
typedef struct HUD_CONFIG_TYPE {
int show_flags; //!< bitfield, whether to show gauge (0 ~ 31)
int show_flags2; //!< bitfield, whether to show gauge (32 ~ 63)
int popup_flags; //!< bitfield, whether gauge is popup (0 ~ 31)
int popup_flags2; //!< bitfield, whether gauge is popup (32 ~ 63)
int rp_flags; //!< one of RP_ #defines in hudconfig.h; Chiefly shows/hides non-ship objects
int rp_dist; //!< one of RR_ #defines above; Is the maxium radar view distance setting
int is_observer; //!< 1 or 0, observer mode or not, respectively
int main_color; //!< the default HUD_COLOR selection for all gauges; each gauge may override this with a custom RGB
ubyte num_msg_window_lines; //!< Number of message lines. (Deprecated by HudGaugeMessages::Max_lines)
color clr[NUM_HUD_GAUGES]; //!< colors for all the gauges
} HUD_CONFIG_TYPE;
extern HUD_CONFIG_TYPE HUD_config;
/**
* @struct HC_gauge_region
* @brief Contains core HUD configuration data
*/
struct HC_gauge_region
{
const char *filename; // filename for the gauge
int x,y; // x, y coords
int hotspot; // ??
int use_iff; // if the gauge uses target IFF color for its color
int can_popup; // if the gauge can use the popup method
int bitmap; // bitmap handle
int nframes; // ??
int color; // If the gauge color respects target tagging?
UI_BUTTON button; // button handle for retail UI hud config
HC_gauge_region(const char *name, int x1, int y1, int h, int iff, int cp, int b, int nf, int cl) : filename(name), x(x1), y(y1), hotspot(h), use_iff(iff), can_popup(cp), bitmap(b), nframes(nf), color(cl){}
};
/*!
* @brief Array of hud gauges to be displayed in the hud config ui and configured by the player
* @note main definition in hudconfig.cpp
*/
extern struct HC_gauge_region HC_gauge_regions[GR_NUM_RESOLUTIONS][NUM_HUD_GAUGES];
extern int HC_gauge_hot;
extern int HC_gauge_selected;
extern int HC_select_all;
extern float HC_gauge_scale;
const char* HC_gauge_descriptions(int n);
/*!
* @brief init hud config screen, setting up the hud preview display
*
* param[in] API_Access whether or not this method has been called from the lua api
* param[in] x the x coord to render the preview display
* param[in] y the y coord to render the preview display
* param[in] w the width to render the preview display
*/
void hud_config_init(bool API_Access = false, int x = 0, int y = 0, int w = -1);
/*!
* @brief do a hud config frame, including rendering the preview display and checking for button presses
*
* param[in] frametime unused
* param[in] API_Access whether or not this method has been called from the lua api
* param[in] mx mouse x coordinate
* param[in] my mouse y coordinate
*/
void hud_config_do_frame(float frametime, bool API_Access = false, int mx = 0, int my = 0);
/*!
* @brief close hud config and release all the bitmaps
*
* param[in] API_Access whether or not this method has been called from the lua api
*/
void hud_config_close(bool API_Access = false);
/*!
* @brief toggles selecting of all gauges for color modification
*
* param[in] toggle 1 to toggle on, 0 for off
* param[in] API_Access whether or not this method has been called from the lua api
*/
void hud_config_select_all_toggle(int toggle, bool API_Access = false);
/*!
* @brief init the list of preset files found by cfile
*/
void hud_config_preset_init();
/*!
* @brief set the entire hud to the default setting or the filename provided
*
* param[in] filename the preset filename to use as the default
*/
void hud_set_default_hud_config(player* p, const char* filename = "hud_3.hcf");
/*!
* @brief delete a preset file and remove it from the preset vector
*/
void hud_config_delete_preset(SCP_string filename);
/*!
* @brief set gauge flags
*
* param[in] gauge_index the gauge to modify
* param[in] on_flag if the gauge is on or off, 1 for on, 0 for off
* param[in] popup_flag if the gauge is set to popup, 1 for popup, 0 otherwise
*/
void hud_config_set_gauge_flags(int gauge_index, int on_flag, int popup_flag);
void hud_config_restore();
void hud_config_backup();
void hud_config_as_observer(ship *shipp,ai_info *aif);
void hud_config_as_player();
/*!
* @brief leave hud config without accepting the player's changes
*/
void hud_config_cancel(bool change_state = true);
/*!
* @brief leave hud config and save the player's changes
*/
void hud_config_commit();
// flag access/manipulation routines
int hud_config_show_flag_is_set(int i);
void hud_config_show_flag_set(int i);
void hud_config_show_flag_clear(int i);
int hud_config_popup_flag_is_set(int i);
void hud_config_popup_flag_set(int i);
void hud_config_popup_flag_clear(int i);
void hud_config_record_color(int color);
void hud_config_set_color(int color);
/*!
* @brief load a preset file to the hud gauges
*/
void hud_config_color_load(const char *name);
/*!
* @brief save the current hud gauges settings to a preset file
*/
void hud_config_color_save(const char* name);
#endif
|
