404 lines
13 KiB
C
404 lines
13 KiB
C
/*
|
|
Copyright (C) 1996-1997 Id Software, Inc.
|
|
|
|
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
|
*/
|
|
|
|
//There are still menu states, which say which menu gets absolute control.
|
|
//Some of the destinations are healthier than others. :)
|
|
|
|
//m_none - menu is disabled
|
|
//m_complex - hirachy of item types
|
|
//m_help - old q1 style help menu (fixme: make m_complex)
|
|
//m_keys - old q1 style key menu (fixme: make m_complex)
|
|
//m_slist - serverbrowser. Takes full control of screen.
|
|
//m_media - an mp3 player type thing. It was never really compleate.
|
|
// It should perhaps either be fixed or removed.
|
|
//m_plugin - A QVM based or DLL based plugin.
|
|
//m_menu_dat- A QC based version of m_plugin. This should be compatible with DP's menu.dat stuff.
|
|
|
|
|
|
//the m_complex menu state is the most advanced, and drives the bulk of FTE's menus in an event driven way.
|
|
//It consists of menus and items. Fairly basic really.
|
|
//Each item type has a structure (or shares a structure).
|
|
//Each of these structures contain a menucommon_t.
|
|
//The backend of this system lives in m_items.c.
|
|
//If you're creating your own quake menu, there should be little need to go in there.
|
|
//These are the item types:
|
|
|
|
//mt_childwindow -
|
|
//mt_button - Executes a console command or callback on enter. Uses conchars.
|
|
//mt_buttonbigfont - Used by hexen2's menus. Uses gfx/menu/bigfont.lmp as it's characters.
|
|
//mt_box - A 2d box. The same one as the quit dialog from q1, but resized.
|
|
//mt_colouredbox - Not used.
|
|
//mt_line - Not used.
|
|
//mt_edit - A one row edit box, either attached to a cvar, or an apply button.
|
|
//mt_text - unselectable. Otherwise like mt_button
|
|
//mt_slider - a horizontal slider, like quake's gamma option, attached to a cvar.
|
|
//mt_combo - multiple specific options. Created with specifically structured info.
|
|
//mt_bind - a key binding option.
|
|
//mt_checkbox - a yes/no toggle, attached to a cvar.
|
|
//mt_picture - Just draws a lmp from it's x/y.
|
|
//mt_menudot - The 24*24 rotating quake menudot. Should be specified as the cursoritem, and should be placed to match the selecteditem's y position.
|
|
//mt_custom - Just an option with callbacks. This is the basis of the top/bottom color seletion, and could be used for all sorts of things.
|
|
|
|
|
|
//Sample menu creation, entirly within /* and */
|
|
//Note that most of FTE's menus are more complicated, as FTE runs on Q1/Q2/H2 data, and it's choice of menu images reflects this.
|
|
//Most of the normal menus also have more items too, of course.
|
|
|
|
//FTE's menu console commands are registered from M_Init_Internal instead of M_Init as implied here. Why?
|
|
//FTE's menu.dat support unregisters the menu console commands so the menu.dat can use those commands instead.
|
|
//This results in more user friendliness for mods but makes the code a little more confusing.
|
|
//If you make the menu name unique enough, then there's no need to follow the standard menu code.
|
|
/*
|
|
//M_SomeMenuConsoleCommand_f
|
|
//Spawns a sample menu.
|
|
void M_SomeMenuConsoleCommand_f (void)
|
|
{
|
|
menu_t *m = M_CreateMenu(0);
|
|
int y = 32;
|
|
|
|
//add the title
|
|
MC_AddCenterPicture(m, 4, 24, "gfx/p_option.lmp");
|
|
|
|
//add the blinking > thingie
|
|
//(note NULL instead of a valid string, this should really be a variant of mt_menudot instead)
|
|
menu->cursoritem = (menuoption_t*)MC_AddWhiteText(menu, 200, y, NULL, false);
|
|
|
|
//Set up so the first item is selected. :)
|
|
m->selecteditem = (menuoption_t*)
|
|
|
|
//Add the items.
|
|
MC_AddConsoleCommand(menu, 16, y, " Customize controls", "menu_keys\n"); y+=8;
|
|
MC_AddSlider(menu, 16, y, " Mouse Speed", &sensitivity, 1, 10); y+=8;
|
|
MC_AddCheckBox(menu, 16, y, " Lookstrafe", &lookstrafe,0); y+=8;
|
|
}
|
|
|
|
//eg: M_Init
|
|
void M_SomeInitialisationFunctionCalledAtStartup(void)
|
|
{
|
|
Cmd_AddCommand("menu_somemenu", M_SomeMenuConsoleCommand_f);
|
|
}
|
|
*/
|
|
|
|
|
|
|
|
//
|
|
// menus
|
|
//
|
|
void M_Init (void);
|
|
void M_Keydown (int key, int unicode);
|
|
void M_Keyup (int key, int unicode);
|
|
void M_Draw (int uimenu);
|
|
void M_ToggleMenu_f (void);
|
|
mpic_t *M_CachePic (char *path);
|
|
void M_DrawTextBox (int x, int y, int width, int lines);
|
|
void M_Menu_Quit_f (void);
|
|
|
|
struct menu_s;
|
|
|
|
|
|
typedef enum {m_none, m_complex, m_help, m_slist, m_media, m_plugin, m_menu_dat} m_state_t;
|
|
extern m_state_t m_state;
|
|
|
|
typedef enum {
|
|
mt_childwindow,
|
|
mt_button,
|
|
mt_qbuttonbigfont,
|
|
mt_hexen2buttonbigfont,
|
|
mt_box,
|
|
mt_colouredbox,
|
|
mt_line,
|
|
mt_edit,
|
|
mt_text,
|
|
mt_slider,
|
|
mt_combo,
|
|
mt_bind,
|
|
mt_checkbox,
|
|
mt_picture,
|
|
mt_picturesel,
|
|
mt_menudot,
|
|
mt_custom
|
|
} menutype_t;
|
|
|
|
typedef struct { //must be first of each structure type.
|
|
menutype_t type;
|
|
int posx;
|
|
int posy;
|
|
int width;
|
|
int height;
|
|
char *tooltip;
|
|
qboolean noselectionsound:1;
|
|
qboolean iszone:1;
|
|
qboolean ishidden:1;
|
|
union menuoption_s *next;
|
|
} menucommon_t;
|
|
|
|
|
|
typedef struct {
|
|
menucommon_t common;
|
|
const char *text;
|
|
const char *command;
|
|
qboolean (*key) (union menuoption_s *option, struct menu_s *, int key);
|
|
} menubutton_t;
|
|
|
|
#define MAX_EDIT_LENGTH 256
|
|
typedef struct {
|
|
menucommon_t common;
|
|
const char *caption;
|
|
cvar_t *cvar;
|
|
char text[MAX_EDIT_LENGTH];
|
|
int cursorpos;
|
|
qboolean modified;
|
|
} menuedit_t;
|
|
typedef struct {
|
|
menucommon_t common;
|
|
float min;
|
|
float max;
|
|
float current;
|
|
float smallchange;
|
|
float largechange;
|
|
cvar_t *var;
|
|
const char *text;
|
|
} menuslider_t;
|
|
|
|
typedef enum {CHK_CHECKED, CHK_TOGGLE} chk_set_t;
|
|
typedef struct menucheck_s {
|
|
menucommon_t common;
|
|
const char *text;
|
|
cvar_t *var;
|
|
int bits;
|
|
float value;
|
|
qboolean (*func) (struct menucheck_s *option, struct menu_s *menu, chk_set_t set);
|
|
} menucheck_t;
|
|
|
|
typedef struct {
|
|
menucommon_t common;
|
|
const char *text;
|
|
qboolean isred;
|
|
} menutext_t;
|
|
|
|
typedef struct menucustom_s {
|
|
menucommon_t common;
|
|
void *data;
|
|
void (*draw) (int x, int y, struct menucustom_s *, struct menu_s *);
|
|
qboolean (*key) (struct menucustom_s *, struct menu_s *, int key);
|
|
} menucustom_t;
|
|
|
|
typedef struct {
|
|
menucommon_t common;
|
|
char *picturename;
|
|
} menupicture_t;
|
|
|
|
typedef struct {
|
|
menucommon_t common;
|
|
int width;
|
|
int height;
|
|
} menubox_t;
|
|
|
|
typedef struct {
|
|
menucommon_t common;
|
|
|
|
const char *caption;
|
|
const char **options;
|
|
const char **values;
|
|
cvar_t *cvar;
|
|
int numoptions;
|
|
int selectedoption;
|
|
} menucombo_t;
|
|
|
|
typedef struct {
|
|
menucommon_t common;
|
|
char *caption;
|
|
char *command;
|
|
} menubind_t;
|
|
|
|
typedef union menuoption_s {
|
|
menucommon_t common;
|
|
menubutton_t button;
|
|
menuedit_t edit;
|
|
menucombo_t combo;
|
|
menuslider_t slider;
|
|
menutext_t text;
|
|
menucustom_t custom;
|
|
menupicture_t picture;
|
|
menubox_t box;
|
|
menucheck_t check;
|
|
menubind_t bind;
|
|
} menuoption_t;
|
|
|
|
typedef struct menutooltip_s {
|
|
char **lines;
|
|
int rows;
|
|
int columns;
|
|
} menutooltip_t;
|
|
|
|
typedef struct menu_s {
|
|
int xpos;
|
|
int ypos;
|
|
int width;
|
|
int height;
|
|
qboolean dontexpand;
|
|
int numoptions;
|
|
|
|
qboolean iszone;
|
|
qboolean exclusive;
|
|
|
|
void *data; //typecast
|
|
|
|
void (*remove) (struct menu_s *);
|
|
qboolean (*key) (int key, struct menu_s *); //true if key was handled
|
|
void (*event) (struct menu_s *);
|
|
menuoption_t *options;
|
|
|
|
menuoption_t *selecteditem;
|
|
|
|
menutooltip_t *tooltip;
|
|
double tooltiptime;
|
|
|
|
struct menu_s *child;
|
|
struct menu_s *parent;
|
|
|
|
int cursorpos;
|
|
menuoption_t *cursoritem;
|
|
} menu_t;
|
|
|
|
menutext_t *MC_AddBufferedText(menu_t *menu, int x, int y, const char *text, qboolean rightalign, qboolean red);
|
|
menutext_t *MC_AddRedText(menu_t *menu, int x, int y, const char *text, qboolean rightalign);
|
|
menutext_t *MC_AddWhiteText(menu_t *menu, int x, int y, const char *text, qboolean rightalign);
|
|
menubind_t *MC_AddBind(menu_t *menu, int x, int y, const char *caption, char *command);
|
|
menubox_t *MC_AddBox(menu_t *menu, int x, int y, int width, int height);
|
|
menupicture_t *MC_AddPicture(menu_t *menu, int x, int y, int width, int height, char *picname);
|
|
menupicture_t *MC_AddSelectablePicture(menu_t *menu, int x, int y, char *picname);
|
|
menupicture_t *MC_AddCenterPicture(menu_t *menu, int y, int height, char *picname);
|
|
menupicture_t *MC_AddCursor(menu_t *menu, int x, int y);
|
|
menuslider_t *MC_AddSlider(menu_t *menu, int x, int y, const char *text, cvar_t *var, float min, float max, float delta);
|
|
menucheck_t *MC_AddCheckBox(menu_t *menu, int x, int y, const char *text, cvar_t *var, int cvarbitmask);
|
|
menucheck_t *MC_AddCheckBoxFunc(menu_t *menu, int x, int y, const char *text, qboolean (*func) (menucheck_t *option, menu_t *menu, chk_set_t set), int bits);
|
|
menubutton_t *MC_AddConsoleCommand(menu_t *menu, int x, int y, const char *text, const char *command);
|
|
menubutton_t *MC_AddConsoleCommandQBigFont(menu_t *menu, int x, int y, const char *text, const char *command);
|
|
mpic_t *QBigFontWorks(void);
|
|
menubutton_t *MC_AddConsoleCommandHexen2BigFont(menu_t *menu, int x, int y, const char *text, const char *command);
|
|
menubutton_t *MC_AddCommand(menu_t *menu, int x, int y, char *text, qboolean (*command) (union menuoption_s *,struct menu_s *,int));
|
|
menucombo_t *MC_AddCombo(menu_t *menu, int x, int y, const char *caption, const char **text, int initialvalue);
|
|
menubutton_t *MC_AddCommand(menu_t *menu, int x, int y, char *text, qboolean (*command) (union menuoption_s *,struct menu_s *,int));
|
|
menuedit_t *MC_AddEdit(menu_t *menu, int x, int y, char *text, char *def);
|
|
menuedit_t *MC_AddEditCvar(menu_t *menu, int x, int y, char *text, char *name);
|
|
menucustom_t *MC_AddCustom(menu_t *menu, int x, int y, void *data);
|
|
menucombo_t *MC_AddCvarCombo(menu_t *menu, int x, int y, const char *caption, cvar_t *cvar, const char **ops, const char **values);
|
|
|
|
menu_t *M_CreateMenu (int extrasize);
|
|
void M_AddMenu (menu_t *menu);
|
|
void M_AddMenuFront (menu_t *menu);
|
|
void M_HideMenu (menu_t *menu);
|
|
void M_RemoveMenu (menu_t *menu);
|
|
void M_RemoveAllMenus (void);
|
|
|
|
void M_Complex_Key(int key, int unicode);
|
|
void M_Complex_Draw(void);
|
|
void M_Script_Init(void);
|
|
void M_Serverlist_Init(void);
|
|
|
|
void M_Menu_Main_f (void);
|
|
void M_Menu_SinglePlayer_f (void);
|
|
void M_Menu_Load_f (void);
|
|
void M_Menu_Save_f (void);
|
|
void M_Menu_MultiPlayer_f (void);
|
|
void M_Menu_Setup_f (void);
|
|
void M_Menu_Net_f (void);
|
|
void M_Menu_Options_f (void);
|
|
void M_Menu_Keys_f (void);
|
|
void M_Menu_Video_f (void);
|
|
void M_Menu_Help_f (void);
|
|
void M_Menu_Quit_f (void);
|
|
void M_Menu_SerialConfig_f (void);
|
|
void M_Menu_ModemConfig_f (void);
|
|
void M_Menu_LanConfig_f (void);
|
|
void M_Menu_GameOptions_f (void);
|
|
void M_Menu_Search_f (void);
|
|
void M_Menu_ServerList_f (void);
|
|
void M_Menu_Media_f (void);
|
|
|
|
void M_Main_Draw (void);
|
|
void M_SinglePlayer_Draw (void);
|
|
void M_Load_Draw (void);
|
|
void M_Save_Draw (void);
|
|
void M_MultiPlayer_Draw (void);
|
|
void M_Setup_Draw (void);
|
|
void M_Net_Draw (void);
|
|
void M_Options_Draw (void);
|
|
void M_Video_Draw (void);
|
|
void M_Help_Draw (void);
|
|
void M_Quit_Draw (void);
|
|
void M_SerialConfig_Draw (void);
|
|
void M_ModemConfig_Draw (void);
|
|
void M_LanConfig_Draw (void);
|
|
void M_GameOptions_Draw (void);
|
|
void M_Search_Draw (void);
|
|
void M_ServerList_Draw (void);
|
|
void M_Media_Draw (void);
|
|
|
|
void M_Main_Key (int key);
|
|
void M_SinglePlayer_Key (int key);
|
|
void M_Load_Key (int key);
|
|
void M_Save_Key (int key);
|
|
void M_MultiPlayer_Key (int key);
|
|
void M_Setup_Key (int key);
|
|
void M_Net_Key (int key);
|
|
void M_Options_Key (int key);
|
|
void M_Video_Key (int key);
|
|
void M_Help_Key (int key);
|
|
void M_Quit_Key (int key);
|
|
void M_SerialConfig_Key (int key);
|
|
void M_ModemConfig_Key (int key);
|
|
void M_LanConfig_Key (int key);
|
|
void M_GameOptions_Key (int key);
|
|
void M_Search_Key (int key);
|
|
void M_ServerList_Key (int key);
|
|
void M_Media_Key (int key);
|
|
|
|
void MasterInfo_Begin(void);
|
|
void M_DrawServers(void);
|
|
void M_SListKey(int key);
|
|
|
|
//drawing funcs
|
|
void M_BuildTranslationTable(int top, int bottom);
|
|
FTE_DEPRECATED void M_DrawTransPicTranslate (int x, int y, mpic_t *pic);
|
|
void M_DrawCharacter (int cx, int line, unsigned int num);
|
|
void M_Print (int cx, int cy, qbyte *str);
|
|
void M_PrintWhite (int cx, int cy, qbyte *str);
|
|
void M_DrawScalePic (int x, int y, int w, int h, mpic_t *pic);
|
|
|
|
|
|
void M_FindKeysForCommand (char *command, int *twokeys);
|
|
void M_UnbindCommand (char *command);
|
|
|
|
void MP_Shutdown (void);
|
|
void MP_Init (void);
|
|
qboolean MP_Toggle(void);
|
|
void MP_Draw(void);
|
|
void MP_RegisterCvarsAndCmds(void);
|
|
void MP_Keydown(int key, int unicode);
|
|
void MP_Keyup(int key, int unicode);
|
|
|
|
#define MGT_BAD ~0
|
|
#define MGT_QUAKE1 0
|
|
#define MGT_HEXEN2 1
|
|
#define MGT_QUAKE2 2
|
|
int M_GameType(void);
|