mirror of https://github.com/FWGS/xash3d-fwgs
251 lines
10 KiB
C
251 lines
10 KiB
C
/*
|
|
menu_int.h - interface between engine and menu
|
|
Copyright (C) 2010 Uncle Mike
|
|
|
|
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 3 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.
|
|
*/
|
|
|
|
#ifndef MENU_INT_H
|
|
#define MENU_INT_H
|
|
|
|
#include "cvardef.h"
|
|
#include "gameinfo.h"
|
|
#include "wrect.h"
|
|
|
|
// a macro for mainui_cpp, indicating that mainui should be compiled for
|
|
// Xash3D 1.0 interface
|
|
#define NEW_ENGINE_INTERFACE
|
|
|
|
typedef int HIMAGE; // handle to a graphic
|
|
|
|
// flags for PIC_Load
|
|
#define PIC_NEAREST (1<<0) // disable texfilter
|
|
#define PIC_KEEP_SOURCE (1<<1) // some images keep source
|
|
#define PIC_NOFLIP_TGA (1<<2) // Steam background completely ignore tga attribute 0x20
|
|
#define PIC_EXPAND_SOURCE (1<<3) // don't keep as 8-bit source, expand to RGBA
|
|
|
|
// flags for COM_ParseFileSafe
|
|
#define PFILE_IGNOREBRACKET (1<<0)
|
|
#define PFILE_HANDLECOLON (1<<1)
|
|
|
|
typedef struct ui_globalvars_s
|
|
{
|
|
float time; // unclamped host.realtime
|
|
float frametime;
|
|
|
|
int scrWidth; // actual values
|
|
int scrHeight;
|
|
|
|
int maxClients;
|
|
int developer; // boolean, changed from allow_console to make mainui_cpp compile for both engines
|
|
int demoplayback;
|
|
int demorecording;
|
|
char demoname[64]; // name of currently playing demo
|
|
char maptitle[64]; // title of active map
|
|
} ui_globalvars_t;
|
|
|
|
struct ref_viewpass_s;
|
|
|
|
typedef struct ui_enginefuncs_s
|
|
{
|
|
// image handlers
|
|
HIMAGE (*pfnPIC_Load)( const char *szPicName, const byte *ucRawImage, int ulRawImageSize, int flags );
|
|
void (*pfnPIC_Free)( const char *szPicName );
|
|
int (*pfnPIC_Width)( HIMAGE hPic );
|
|
int (*pfnPIC_Height)( HIMAGE hPic );
|
|
void (*pfnPIC_Set)( HIMAGE hPic, int r, int g, int b, int a );
|
|
void (*pfnPIC_Draw)( int x, int y, int width, int height, const wrect_t *prc );
|
|
void (*pfnPIC_DrawHoles)( int x, int y, int width, int height, const wrect_t *prc );
|
|
void (*pfnPIC_DrawTrans)( int x, int y, int width, int height, const wrect_t *prc );
|
|
void (*pfnPIC_DrawAdditive)( int x, int y, int width, int height, const wrect_t *prc );
|
|
void (*pfnPIC_EnableScissor)( int x, int y, int width, int height );
|
|
void (*pfnPIC_DisableScissor)( void );
|
|
|
|
// screen handlers
|
|
void (*pfnFillRGBA)( int x, int y, int width, int height, int r, int g, int b, int a );
|
|
|
|
// cvar handlers
|
|
cvar_t* (*pfnRegisterVariable)( const char *szName, const char *szValue, int flags );
|
|
float (*pfnGetCvarFloat)( const char *szName );
|
|
const char* (*pfnGetCvarString)( const char *szName );
|
|
void (*pfnCvarSetString)( const char *szName, const char *szValue );
|
|
void (*pfnCvarSetValue)( const char *szName, float flValue );
|
|
|
|
// command handlers
|
|
int (*pfnAddCommand)( const char *cmd_name, void (*function)(void) );
|
|
void (*pfnClientCmd)( int execute_now, const char *szCmdString );
|
|
void (*pfnDelCommand)( const char *cmd_name );
|
|
int (*pfnCmdArgc)( void );
|
|
const char* (*pfnCmdArgv)( int argc );
|
|
const char* (*pfnCmd_Args)( void );
|
|
|
|
// debug messages (in-menu shows only notify)
|
|
void (*Con_Printf)( const char *fmt, ... ) _format( 1 );
|
|
void (*Con_DPrintf)( const char *fmt, ... ) _format( 1 );
|
|
void (*Con_NPrintf)( int pos, const char *fmt, ... ) _format( 2 );
|
|
void (*Con_NXPrintf)( struct con_nprint_s *info, const char *fmt, ... ) _format( 2 );
|
|
|
|
// sound handlers
|
|
void (*pfnPlayLocalSound)( const char *szSound );
|
|
|
|
// cinematic handlers
|
|
void (*pfnDrawLogo)( const char *filename, float x, float y, float width, float height );
|
|
int (*pfnGetLogoWidth)( void );
|
|
int (*pfnGetLogoHeight)( void );
|
|
float (*pfnGetLogoLength)( void ); // cinematic duration in seconds
|
|
|
|
// text message system
|
|
void (*pfnDrawCharacter)( int x, int y, int width, int height, int ch, int ulRGBA, HIMAGE hFont );
|
|
int (*pfnDrawConsoleString)( int x, int y, const char *string );
|
|
void (*pfnDrawSetTextColor)( int r, int g, int b, int alpha );
|
|
void (*pfnDrawConsoleStringLen)( const char *string, int *length, int *height );
|
|
void (*pfnSetConsoleDefaultColor)( int r, int g, int b ); // color must came from colors.lst
|
|
|
|
// custom rendering (for playermodel preview)
|
|
struct cl_entity_s* (*pfnGetPlayerModel)( void ); // for drawing playermodel previews
|
|
void (*pfnSetModel)( struct cl_entity_s *ed, const char *path );
|
|
void (*pfnClearScene)( void );
|
|
void (*pfnRenderScene)( const struct ref_viewpass_s *rvp );
|
|
int (*CL_CreateVisibleEntity)( int type, struct cl_entity_s *ent );
|
|
|
|
// misc handlers
|
|
void (*pfnHostError)( const char *szFmt, ... ) _format( 1 );
|
|
int (*pfnFileExists)( const char *filename, int gamedironly );
|
|
void (*pfnGetGameDir)( char *szGetGameDir );
|
|
|
|
// gameinfo handlers
|
|
int (*pfnCreateMapsList)( int fRefresh );
|
|
int (*pfnClientInGame)( void );
|
|
void (*pfnClientJoin)( const struct netadr_s adr );
|
|
|
|
// parse txt files
|
|
byte* (*COM_LoadFile)( const char *filename, int *pLength );
|
|
char* (*COM_ParseFile)( char *data, char *token );
|
|
void (*COM_FreeFile)( void *buffer );
|
|
|
|
// keyfuncs
|
|
void (*pfnKeyClearStates)( void ); // call when menu open or close
|
|
void (*pfnSetKeyDest)( int dest );
|
|
const char *(*pfnKeynumToString)( int keynum );
|
|
const char *(*pfnKeyGetBinding)( int keynum );
|
|
void (*pfnKeySetBinding)( int keynum, const char *binding );
|
|
int (*pfnKeyIsDown)( int keynum );
|
|
int (*pfnKeyGetOverstrikeMode)( void );
|
|
void (*pfnKeySetOverstrikeMode)( int fActive );
|
|
void *(*pfnKeyGetState)( const char *name ); // for mlook, klook etc
|
|
|
|
// engine memory manager
|
|
void* (*pfnMemAlloc)( size_t cb, const char *filename, const int fileline ) ALLOC_CHECK( 1 );
|
|
void (*pfnMemFree)( void *mem, const char *filename, const int fileline );
|
|
|
|
// collect info from engine
|
|
int (*pfnGetGameInfo)( GAMEINFO *pgameinfo );
|
|
GAMEINFO **(*pfnGetGamesList)( int *numGames ); // collect info about all mods
|
|
char **(*pfnGetFilesList)( const char *pattern, int *numFiles, int gamedironly ); // find in files
|
|
int (*pfnGetSaveComment)( const char *savename, char *comment );
|
|
int (*pfnGetDemoComment)( const char *demoname, char *comment );
|
|
int (*pfnCheckGameDll)( void ); // returns false if hl.dll is missed or invalid
|
|
char *(*pfnGetClipboardData)( void );
|
|
|
|
// engine launcher
|
|
void (*pfnShellExecute)( const char *name, const char *args, int closeEngine );
|
|
void (*pfnWriteServerConfig)( const char *name );
|
|
void (*pfnChangeInstance)( const char *newInstance, const char *szFinalMessage );
|
|
void (*pfnPlayBackgroundTrack)( const char *introName, const char *loopName );
|
|
void (*pfnHostEndGame)( const char *szFinalMessage );
|
|
|
|
// menu interface is freezed at version 0.75
|
|
// new functions starts here
|
|
float (*pfnRandomFloat)( float flLow, float flHigh );
|
|
int (*pfnRandomLong)( int lLow, int lHigh );
|
|
|
|
void (*pfnSetCursor)( void *hCursor ); // change cursor
|
|
int (*pfnIsMapValid)( char *filename );
|
|
void (*pfnProcessImage)( int texnum, float gamma, int topColor, int bottomColor );
|
|
int (*pfnCompareFileTime)( const char *filename1, const char *filename2, int *iCompare );
|
|
|
|
const char *(*pfnGetModeString)( int vid_mode );
|
|
int (*COM_SaveFile)( const char *filename, const void *data, int len );
|
|
int (*COM_RemoveFile)( const char *filepath );
|
|
} ui_enginefuncs_t;
|
|
|
|
typedef struct
|
|
{
|
|
int (*pfnVidInit)( void );
|
|
void (*pfnInit)( void );
|
|
void (*pfnShutdown)( void );
|
|
void (*pfnRedraw)( float flTime );
|
|
void (*pfnKeyEvent)( int key, int down );
|
|
void (*pfnMouseMove)( int x, int y );
|
|
void (*pfnSetActiveMenu)( int active );
|
|
void (*pfnAddServerToList)( struct netadr_s adr, const char *info );
|
|
void (*pfnGetCursorPos)( int *pos_x, int *pos_y );
|
|
void (*pfnSetCursorPos)( int pos_x, int pos_y );
|
|
void (*pfnShowCursor)( int show );
|
|
void (*pfnCharEvent)( int key );
|
|
int (*pfnMouseInRect)( void ); // mouse entering\leave game window
|
|
int (*pfnIsVisible)( void );
|
|
int (*pfnCreditsActive)( void ); // unused
|
|
void (*pfnFinalCredits)( void ); // show credits + game end
|
|
} UI_FUNCTIONS;
|
|
|
|
#define MENU_EXTENDED_API_VERSION 1
|
|
|
|
typedef struct ui_extendedfuncs_s {
|
|
// text functions, frozen
|
|
void (*pfnEnableTextInput)( int enable );
|
|
int (*pfnUtfProcessChar) ( int ch );
|
|
int (*pfnUtfMoveLeft) ( char *str, int pos );
|
|
int (*pfnUtfMoveRight) ( char *str, int pos, int length );
|
|
|
|
// new engine extended api start here
|
|
// returns 1 if there are more in list, otherwise 0
|
|
int (*pfnGetRenderers)( unsigned int num, char *shortName, size_t size1, char *readableName, size_t size2 );
|
|
double (*pfnDoubleTime)( void );
|
|
char *(*pfnParseFile)( char *data, char *buf, const int size, unsigned int flags, int *len );
|
|
|
|
// network address funcs
|
|
const char *(*pfnAdrToString)( const struct netadr_s a );
|
|
int (*pfnCompareAdr)( const void *a, const void *b ); // netadr_t
|
|
void *(*pfnGetNativeObject)( const char *name );
|
|
} ui_extendedfuncs_t;
|
|
|
|
// deprecated export from old engine
|
|
typedef void (*ADDTOUCHBUTTONTOLIST)( const char *name, const char *texture, const char *command, unsigned char *color, int flags );
|
|
|
|
typedef struct
|
|
{
|
|
ADDTOUCHBUTTONTOLIST pfnAddTouchButtonToList;
|
|
void (*pfnResetPing)( void );
|
|
void (*pfnShowConnectionWarning)( void );
|
|
void (*pfnShowUpdateDialog)( int preferStore );
|
|
void (*pfnShowMessageBox)( const char *text );
|
|
void (*pfnConnectionProgress_Disconnect)( void );
|
|
void (*pfnConnectionProgress_Download)( const char *pszFileName, const char *pszServerName, int iCurrent, int iTotal, const char *comment );
|
|
void (*pfnConnectionProgress_DownloadEnd)( void );
|
|
void (*pfnConnectionProgress_Precache)( void );
|
|
void (*pfnConnectionProgress_Connect)( const char *server ); // NULL for local server
|
|
void (*pfnConnectionProgress_ChangeLevel)( void );
|
|
void (*pfnConnectionProgress_ParseServerInfo)( const char *server );
|
|
} UI_EXTENDED_FUNCTIONS;
|
|
|
|
typedef int (*MENUAPI)( UI_FUNCTIONS *pFunctionTable, ui_enginefuncs_t* engfuncs, ui_globalvars_t *pGlobals );
|
|
|
|
typedef int (*UIEXTENEDEDAPI)( int version, UI_EXTENDED_FUNCTIONS *pFunctionTable, ui_extendedfuncs_t *engfuncs );
|
|
|
|
// deprecated interface from old engine
|
|
typedef int (*UITEXTAPI)( ui_extendedfuncs_t* engfuncs );
|
|
|
|
#define PLATFORM_UPDATE_PAGE "PlatformUpdatePage"
|
|
#define GENERIC_UPDATE_PAGE "GenericUpdatePage"
|
|
|
|
#endif//MENU_INT_H
|