sourcemm/convar.h
author David Anderson <dvander@alliedmods.net>
Wed Aug 09 02:05:57 2006 +0000 (2006-08-09)
changeset 232 a86d52ff721c
parent 76 39266faeec97
child 238 c27105949293
permissions -rw-r--r--
Merged in changes from the latest SDK
dvander@76
     1
//========= Copyright � 1996-2005, Valve Corporation, All rights reserved. ============//
dvander@76
     2
//
dvander@76
     3
// Purpose: 
dvander@76
     4
//
dvander@76
     5
// $Workfile:     $
dvander@76
     6
// $Date$
dvander@76
     7
//
dvander@76
     8
//-----------------------------------------------------------------------------
dvander@76
     9
// $NoKeywords: $
dvander@76
    10
//=============================================================================//
dvander@76
    11
dvander@76
    12
#ifndef CONVAR_H
dvander@76
    13
#define CONVAR_H
dvander@76
    14
#if _WIN32
dvander@76
    15
#pragma once
dvander@76
    16
#endif
dvander@76
    17
dvander@76
    18
#include "tier0/dbg.h"
dvander@76
    19
dvander@232
    20
#ifdef _WIN32
dvander@232
    21
#define FORCEINLINE_CVAR FORCEINLINE
dvander@232
    22
#elif _LINUX
dvander@232
    23
#define FORCEINLINE_CVAR __inline__ FORCEINLINE
dvander@232
    24
#else
dvander@232
    25
#error "implement me"
dvander@232
    26
#endif
dvander@232
    27
dvander@76
    28
// The default, no flags at all
dvander@76
    29
#define FCVAR_NONE				0 
dvander@76
    30
dvander@76
    31
// Command to ConVars and ConCommands
dvander@232
    32
// ConVar Systems
dvander@76
    33
#define FCVAR_UNREGISTERED		(1<<0)	// If this is set, don't add to linked list, etc.
dvander@232
    34
#define FCVAR_LAUNCHER			(1<<1)	// defined by launcher
dvander@76
    35
#define FCVAR_GAMEDLL			(1<<2)	// defined by the game DLL
dvander@76
    36
#define FCVAR_CLIENTDLL			(1<<3)  // defined by the client DLL
dvander@76
    37
#define FCVAR_MATERIAL_SYSTEM	(1<<4)	// Defined by the material system.
dvander@232
    38
#define FCVAR_DATACACHE			(1<<19)	// Defined by the datacache system.
dvander@232
    39
#define FCVAR_STUDIORENDER		(1<<15)	// Defined by the studiorender system.
dvander@232
    40
#define FCVAR_FILESYSTEM		(1<<21)	// Defined by the file system.
dvander@76
    41
#define FCVAR_PLUGIN			(1<<18)	// Defined by a 3rd party plugin.
dvander@232
    42
#define FCVAR_TOOLSYSTEM		(1<<20)	// Defined by an IToolSystem library
dvander@232
    43
#define FCVAR_SOUNDSYSTEM		(1<<23)	// Defined by the soundsystem library
dvander@232
    44
#define FCVAR_INPUTSYSTEM		(1<<25)	// Defined by the inputsystem dll
dvander@232
    45
#define FCVAR_NETWORKSYSTEM		(1<<26) // Defined by the network system
dvander@232
    46
// NOTE!! if you add a cvar system, add it here too!!!!
dvander@232
    47
// the engine lacks a cvar flag, but needs it for xbox
dvander@232
    48
// an engine cvar is thus a cvar not marked with any other system
dvander@232
    49
#define FCVAR_NON_ENGINE		((FCVAR_LAUNCHER|FCVAR_GAMEDLL|FCVAR_CLIENTDLL|FCVAR_MATERIAL_SYSTEM|FCVAR_DATACACHE|FCVAR_STUDIORENDER|FCVAR_FILESYSTEM|FCVAR_PLUGIN|FCVAR_TOOLSYSTEM|FCVAR_SOUNDSYSTEM|FCVAR_INPUTSYSTEM|FCVAR_NETWORKSYSTEM))
dvander@76
    50
dvander@76
    51
// ConVar only
dvander@76
    52
#define FCVAR_PROTECTED			(1<<5)  // It's a server cvar, but we don't send the data since it's a password, etc.  Sends 1 if it's not bland/zero, 0 otherwise as value
dvander@76
    53
#define FCVAR_SPONLY			(1<<6)  // This cvar cannot be changed by clients connected to a multiplayer server.
dvander@76
    54
#define	FCVAR_ARCHIVE			(1<<7)	// set to cause it to be saved to vars.rc
dvander@76
    55
#define	FCVAR_NOTIFY			(1<<8)	// notifies players when changed
dvander@76
    56
#define	FCVAR_USERINFO			(1<<9)	// changes the client's info string
dvander@232
    57
#define FCVAR_CHEAT				(1<<14) // Only useable in singleplayer / debug / multiplayer & sv_cheats
dvander@76
    58
dvander@76
    59
#define FCVAR_PRINTABLEONLY		(1<<10)  // This cvar's string cannot contain unprintable characters ( e.g., used for player name etc ).
dvander@76
    60
#define FCVAR_UNLOGGED			(1<<11)  // If this is a FCVAR_SERVER, don't log changes to the log file / console if we are creating a log
dvander@76
    61
#define FCVAR_NEVER_AS_STRING	(1<<12)  // never try to print that cvar
dvander@76
    62
dvander@76
    63
// It's a ConVar that's shared between the client and the server.
dvander@76
    64
// At signon, the values of all such ConVars are sent from the server to the client (skipped for local
dvander@76
    65
//  client, of course )
dvander@76
    66
// If a change is requested it must come from the console (i.e., no remote client changes)
dvander@76
    67
// If a value is changed while a server is active, it's replicated to all connected clients
dvander@76
    68
#define FCVAR_REPLICATED		(1<<13)	// server setting enforced on clients, TODO rename to FCAR_SERVER at some time
dvander@76
    69
#define FCVAR_DEMO				(1<<16)  // record this cvar when starting a demo file
dvander@76
    70
#define FCVAR_DONTRECORD		(1<<17)  // don't record these command in demofiles
dvander@76
    71
dvander@232
    72
#define FCVAR_NOT_CONNECTED		(1<<22)	// cvar cannot be changed by a client that is connected to a server
dvander@232
    73
dvander@232
    74
#define FCVAR_ARCHIVE_XBOX		(1<<24) // cvar written to config.cfg on the Xbox
dvander@232
    75
dvander@232
    76
dvander@232
    77
// #define FCVAR_AVAILABLE			(1<<27)
dvander@232
    78
// #define FCVAR_AVAILABLE			(1<<28)
dvander@232
    79
// #define FCVAR_AVAILABLE			(1<<29)
dvander@232
    80
// #define FCVAR_AVAILABLE			(1<<30)
dvander@232
    81
// #define FCVAR_AVAILABLE			(1<<31)
dvander@76
    82
dvander@76
    83
dvander@76
    84
class ConVar;
dvander@76
    85
class ConCommand;
dvander@76
    86
class ConCommandBase;
dvander@76
    87
dvander@76
    88
// Any executable that wants to use ConVars need to implement one of
dvander@76
    89
// these to hook up access to console variables.
dvander@76
    90
class IConCommandBaseAccessor
dvander@76
    91
{
dvander@76
    92
public:
dvander@76
    93
	// Flags is a combination of FCVAR flags in cvar.h.
dvander@76
    94
	// hOut is filled in with a handle to the variable.
dvander@76
    95
	virtual bool RegisterConCommandBase( ConCommandBase *pVar )=0;
dvander@76
    96
};
dvander@76
    97
dvander@76
    98
dvander@76
    99
// You don't have to instantiate one of these, just call its 
dvander@76
   100
// OneTimeInit function when your executable is initializing.
dvander@76
   101
class ConCommandBaseMgr
dvander@76
   102
{
dvander@76
   103
public:
dvander@76
   104
	// Call this ONCE when the executable starts up.
dvander@76
   105
	static void	OneTimeInit( IConCommandBaseAccessor *pAccessor );
dvander@232
   106
#ifdef _XBOX
dvander@232
   107
	static bool Fixup( ConCommandBase* pConCommandBase );
dvander@232
   108
#ifndef _RETAIL
dvander@232
   109
	static void PublishCommands( bool bForce );
dvander@232
   110
#endif
dvander@232
   111
#endif
dvander@76
   112
};
dvander@76
   113
dvander@76
   114
// Called when a ConVar changes value
dvander@76
   115
typedef void ( *FnChangeCallback )( ConVar *var, char const *pOldString );
dvander@76
   116
dvander@76
   117
// Called when a ConCommand needs to execute
dvander@76
   118
typedef void ( *FnCommandCallback )( void );
dvander@76
   119
dvander@76
   120
#define COMMAND_COMPLETION_MAXITEMS		64
dvander@76
   121
#define COMMAND_COMPLETION_ITEM_LENGTH	64
dvander@76
   122
dvander@76
   123
// Returns 0 to COMMAND_COMPLETION_MAXITEMS worth of completion strings
dvander@76
   124
typedef int  ( *FnCommandCompletionCallback )( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
dvander@76
   125
dvander@76
   126
//-----------------------------------------------------------------------------
dvander@76
   127
// Purpose: The base console invoked command/cvar interface
dvander@76
   128
//-----------------------------------------------------------------------------
dvander@76
   129
class ConCommandBase
dvander@76
   130
{
dvander@76
   131
	friend class ConCommandBaseMgr;
dvander@76
   132
	friend class CCvar;
dvander@76
   133
	friend class ConVar;
dvander@76
   134
	friend class ConCommand;
dvander@76
   135
dvander@76
   136
public:
dvander@76
   137
								ConCommandBase( void );
dvander@76
   138
								ConCommandBase( char const *pName, char const *pHelpString = 0, 
dvander@76
   139
									int flags = 0 );
dvander@76
   140
dvander@76
   141
	virtual						~ConCommandBase( void );
dvander@76
   142
dvander@76
   143
	virtual	bool				IsCommand( void ) const;
dvander@76
   144
dvander@76
   145
	// Check flag
dvander@76
   146
	virtual bool				IsBitSet( int flag ) const;
dvander@76
   147
	// Set flag
dvander@76
   148
	virtual void				AddFlags( int flags );
dvander@76
   149
dvander@76
   150
	// Return name of cvar
dvander@76
   151
	virtual char const			*GetName( void ) const;
dvander@76
   152
dvander@76
   153
	// Return help text for cvar
dvander@76
   154
	virtual char const			*GetHelpText( void ) const;
dvander@76
   155
dvander@76
   156
	// Deal with next pointer
dvander@76
   157
	const ConCommandBase		*GetNext( void ) const;
dvander@76
   158
	void						SetNext( ConCommandBase *next );
dvander@76
   159
	
dvander@76
   160
	virtual bool				IsRegistered( void ) const;
dvander@76
   161
dvander@76
   162
	// Global methods
dvander@76
   163
	static ConCommandBase const	*GetCommands( void );
dvander@76
   164
	static void					AddToList( ConCommandBase *var );
dvander@76
   165
	static void					RemoveFlaggedCommands( int flag );
dvander@76
   166
	static void					RevertFlaggedCvars( int flag );
dvander@76
   167
	static ConCommandBase const	*FindCommand( char const *name );
dvander@76
   168
dvander@76
   169
protected:
dvander@76
   170
	virtual void				Create( char const *pName, char const *pHelpString = 0, 
dvander@76
   171
									int flags = 0 );
dvander@76
   172
dvander@76
   173
	// Used internally by OneTimeInit to initialize.
dvander@76
   174
	virtual void				Init();
dvander@76
   175
dvander@76
   176
	// Internal copy routine ( uses new operator from correct module )
dvander@76
   177
	char						*CopyString( char const *from );
dvander@76
   178
dvander@76
   179
	// Next ConVar in chain
dvander@76
   180
	ConCommandBase				*m_pNext;
dvander@76
   181
dvander@76
   182
private:
dvander@76
   183
	// Has the cvar been added to the global list?
dvander@76
   184
	bool						m_bRegistered;
dvander@76
   185
dvander@76
   186
	// Static data
dvander@76
   187
	char const 					*m_pszName;
dvander@76
   188
	char const 					*m_pszHelpString;
dvander@76
   189
	
dvander@76
   190
	// ConVar flags
dvander@76
   191
	int							m_nFlags;
dvander@76
   192
dvander@76
   193
protected:
dvander@76
   194
dvander@76
   195
	// ConVars add themselves to this list for the executable. Then ConVarMgr::Init() runs through 
dvander@76
   196
	// all the console variables and registers them.
dvander@76
   197
	static ConCommandBase		*s_pConCommandBases;
dvander@76
   198
dvander@76
   199
	// ConVars in this executable use this 'global' to access values.
dvander@76
   200
	static IConCommandBaseAccessor	*s_pAccessor;
dvander@76
   201
};
dvander@76
   202
dvander@76
   203
//-----------------------------------------------------------------------------
dvander@76
   204
// Purpose: The console invoked command
dvander@76
   205
//-----------------------------------------------------------------------------
dvander@76
   206
class ConCommand : public ConCommandBase
dvander@76
   207
{
dvander@76
   208
friend class ConCommandBaseMgr;
dvander@76
   209
friend class CCvar;
dvander@232
   210
#ifdef _STATIC_LINKED
dvander@232
   211
friend class G_ConCommand;
dvander@232
   212
friend class C_ConCommand;
dvander@232
   213
friend class M_ConCommand;
dvander@232
   214
friend class S_ConCommand;
dvander@232
   215
friend class D_ConCommand;
dvander@232
   216
#endif
dvander@76
   217
dvander@76
   218
public:
dvander@76
   219
	typedef ConCommandBase BaseClass;
dvander@76
   220
dvander@76
   221
								ConCommand( void );
dvander@76
   222
								ConCommand( char const *pName, FnCommandCallback callback, 
dvander@76
   223
									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
dvander@76
   224
dvander@76
   225
	virtual						~ConCommand( void );
dvander@76
   226
dvander@76
   227
	virtual	bool				IsCommand( void ) const;
dvander@76
   228
dvander@76
   229
	virtual int					AutoCompleteSuggest( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
dvander@76
   230
dvander@76
   231
	virtual bool				CanAutoComplete( void );
dvander@76
   232
dvander@76
   233
	// Invoke the function
dvander@76
   234
	virtual void				Dispatch( void );
dvander@76
   235
private:
dvander@76
   236
	virtual void				Create( char const *pName, FnCommandCallback callback, 
dvander@76
   237
									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
dvander@232
   238
dvander@76
   239
	// Call this function when executing the command
dvander@76
   240
	FnCommandCallback			m_fnCommandCallback;
dvander@76
   241
dvander@76
   242
	FnCommandCompletionCallback	m_fnCompletionCallback;
dvander@76
   243
	bool						m_bHasCompletionCallback;
dvander@76
   244
public:
dvander@232
   245
	FnCommandCallback		GetCallback() { return m_fnCommandCallback; }
dvander@76
   246
};
dvander@76
   247
dvander@76
   248
//-----------------------------------------------------------------------------
dvander@76
   249
// Purpose: A console variable
dvander@76
   250
//-----------------------------------------------------------------------------
dvander@76
   251
class ConVar : public ConCommandBase
dvander@76
   252
{
dvander@76
   253
friend class ConCommandBaseMgr;
dvander@76
   254
friend class CCvar;
dvander@76
   255
friend class CDefaultCvar;
dvander@232
   256
#ifdef _STATIC_LINKED
dvander@232
   257
friend class G_ConVar;
dvander@232
   258
friend class C_ConVar;
dvander@232
   259
friend class M_ConVar;
dvander@232
   260
friend class S_ConVar;
dvander@232
   261
friend class D_ConVar;
dvander@232
   262
#endif
dvander@76
   263
dvander@76
   264
public:
dvander@76
   265
	typedef ConCommandBase BaseClass;
dvander@76
   266
dvander@76
   267
								ConVar( char const *pName, char const *pDefaultValue, int flags = 0);
dvander@76
   268
dvander@76
   269
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   270
									char const *pHelpString );
dvander@76
   271
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   272
									char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax );
dvander@76
   273
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   274
									char const *pHelpString, FnChangeCallback callback );
dvander@76
   275
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   276
									char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax,
dvander@76
   277
									FnChangeCallback callback );
dvander@76
   278
dvander@76
   279
	virtual						~ConVar( void );
dvander@76
   280
dvander@76
   281
	virtual bool				IsBitSet( int flag ) const;
dvander@76
   282
	virtual char const*			GetHelpText( void ) const;
dvander@76
   283
	virtual bool				IsRegistered( void ) const;
dvander@76
   284
	virtual char const			*GetName( void ) const;
dvander@76
   285
	virtual void				AddFlags( int flags );
dvander@76
   286
	virtual	bool				IsCommand( void ) const;
dvander@76
   287
dvander@76
   288
	// Install a change callback (there shouldn't already be one....)
dvander@76
   289
	void InstallChangeCallback( FnChangeCallback callback );
dvander@76
   290
dvander@76
   291
	// Retrieve value
dvander@232
   292
	FORCEINLINE_CVAR float			GetFloat( void ) const;
dvander@232
   293
	FORCEINLINE_CVAR int				GetInt( void ) const;
dvander@232
   294
	FORCEINLINE_CVAR bool			GetBool() const {  return !!GetInt(); }
dvander@232
   295
	FORCEINLINE_CVAR char const	   *GetString( void ) const;
dvander@76
   296
dvander@76
   297
	// Any function that allocates/frees memory needs to be virtual or else you'll have crashes
dvander@76
   298
	//  from alloc/free across dll/exe boundaries.
dvander@76
   299
	
dvander@76
   300
	// These just call into the IConCommandBaseAccessor to check flags and set the var (which ends up calling InternalSetValue).
dvander@76
   301
	virtual void				SetValue( char const *value );
dvander@76
   302
	virtual void				SetValue( float value );
dvander@76
   303
	virtual void				SetValue( int value );
dvander@76
   304
	
dvander@76
   305
	// Reset to default value
dvander@76
   306
	void						Revert( void );
dvander@76
   307
dvander@76
   308
	// True if it has a min/max setting
dvander@76
   309
	bool						GetMin( float& minVal ) const;
dvander@76
   310
	bool						GetMax( float& maxVal ) const;
dvander@76
   311
	char const					*GetDefault( void ) const;
dvander@76
   312
dvander@76
   313
	static void					RevertAll( void );
dvander@76
   314
private:
dvander@76
   315
	// Called by CCvar when the value of a var is changing.
dvander@76
   316
	virtual void				InternalSetValue(char const *value);
dvander@76
   317
	// For CVARs marked FCVAR_NEVER_AS_STRING
dvander@76
   318
	virtual void				InternalSetFloatValue( float fNewValue );
dvander@76
   319
	virtual void				InternalSetIntValue( int nValue );
dvander@76
   320
dvander@76
   321
	virtual bool				ClampValue( float& value );
dvander@76
   322
	virtual void				ChangeStringValue( char const *tempVal );
dvander@76
   323
dvander@76
   324
	virtual void				Create( char const *pName, char const *pDefaultValue, int flags = 0,
dvander@76
   325
									char const *pHelpString = 0, bool bMin = false, float fMin = 0.0,
dvander@76
   326
									bool bMax = false, float fMax = false, FnChangeCallback callback = 0 );
dvander@76
   327
dvander@76
   328
	// Used internally by OneTimeInit to initialize.
dvander@76
   329
	virtual void				Init();
dvander@76
   330
dvander@76
   331
private:
dvander@76
   332
dvander@76
   333
	// This either points to "this" or it points to the original declaration of a ConVar.
dvander@76
   334
	// This allows ConVars to exist in separate modules, and they all use the first one to be declared.
dvander@76
   335
	// m_pParent->m_pParent must equal m_pParent (ie: m_pParent must be the root, or original, ConVar).
dvander@76
   336
	ConVar						*m_pParent;
dvander@76
   337
dvander@76
   338
	// Static data
dvander@76
   339
	char const					*m_pszDefaultValue;
dvander@76
   340
	
dvander@76
   341
	// Value
dvander@76
   342
	// Dynamically allocated
dvander@76
   343
	char						*m_pszString;
dvander@76
   344
	int							m_StringLength;
dvander@76
   345
dvander@76
   346
	// Values
dvander@76
   347
	float						m_fValue;
dvander@76
   348
	int							m_nValue;
dvander@76
   349
dvander@76
   350
	// Min/Max values
dvander@76
   351
	bool						m_bHasMin;
dvander@76
   352
	float						m_fMinVal;
dvander@76
   353
	bool						m_bHasMax;
dvander@76
   354
	float						m_fMaxVal;
dvander@76
   355
	
dvander@76
   356
	// Call this function when ConVar changes
dvander@76
   357
	FnChangeCallback			m_fnChangeCallback;
dvander@76
   358
};
dvander@76
   359
dvander@232
   360
dvander@76
   361
//-----------------------------------------------------------------------------
dvander@76
   362
// Purpose: Return ConVar value as a float
dvander@76
   363
// Output : float
dvander@76
   364
//-----------------------------------------------------------------------------
dvander@232
   365
FORCEINLINE_CVAR float ConVar::GetFloat( void ) const
dvander@76
   366
{
dvander@76
   367
	return m_pParent->m_fValue;
dvander@76
   368
}
dvander@76
   369
dvander@76
   370
//-----------------------------------------------------------------------------
dvander@76
   371
// Purpose: Return ConVar value as an int
dvander@76
   372
// Output : int
dvander@76
   373
//-----------------------------------------------------------------------------
dvander@232
   374
FORCEINLINE_CVAR int ConVar::GetInt( void ) const 
dvander@76
   375
{
dvander@76
   376
	return m_pParent->m_nValue;
dvander@76
   377
}
dvander@76
   378
dvander@76
   379
dvander@76
   380
//-----------------------------------------------------------------------------
dvander@76
   381
// Purpose: Return ConVar value as a string, return "" for bogus string pointer, etc.
dvander@76
   382
// Output : char const *
dvander@76
   383
//-----------------------------------------------------------------------------
dvander@232
   384
FORCEINLINE_CVAR char const *ConVar::GetString( void ) const 
dvander@76
   385
{
dvander@76
   386
	if ( m_nFlags & FCVAR_NEVER_AS_STRING )
dvander@76
   387
	{
dvander@76
   388
		return "FCVAR_NEVER_AS_STRING";
dvander@76
   389
	}
dvander@76
   390
dvander@76
   391
	return ( m_pParent->m_pszString ) ? m_pParent->m_pszString : "";
dvander@76
   392
}
dvander@76
   393
dvander@76
   394
dvander@232
   395
#ifdef _STATIC_LINKED
dvander@232
   396
// identifies subsystem via piggybacking constructors with flags
dvander@232
   397
class G_ConCommand : public ConCommand
dvander@232
   398
{
dvander@232
   399
public:
dvander@232
   400
	G_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_GAMEDLL, completionFunc) {}
dvander@232
   401
};
dvander@232
   402
dvander@232
   403
class C_ConCommand : public ConCommand
dvander@232
   404
{
dvander@232
   405
public:
dvander@232
   406
	C_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_CLIENTDLL, completionFunc) {}
dvander@232
   407
};
dvander@232
   408
dvander@232
   409
class M_ConCommand : public ConCommand
dvander@232
   410
{
dvander@232
   411
public:
dvander@232
   412
	M_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_MATERIAL_SYSTEM, completionFunc) {}
dvander@232
   413
};
dvander@232
   414
dvander@232
   415
class S_ConCommand : public ConCommand
dvander@232
   416
{
dvander@232
   417
public:
dvander@232
   418
	S_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_STUDIORENDER, completionFunc) {}
dvander@232
   419
};
dvander@232
   420
dvander@232
   421
class D_ConCommand : public ConCommand
dvander@232
   422
{
dvander@232
   423
public:
dvander@232
   424
	D_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_DATACACHE, completionFunc) {}
dvander@232
   425
};
dvander@232
   426
dvander@232
   427
typedef void ( *G_FnChangeCallback )( G_ConVar *var, char const *pOldString );
dvander@232
   428
typedef void ( *C_FnChangeCallback )( C_ConVar *var, char const *pOldString );
dvander@232
   429
typedef void ( *M_FnChangeCallback )( M_ConVar *var, char const *pOldString );
dvander@232
   430
typedef void ( *S_FnChangeCallback )( S_ConVar *var, char const *pOldString );
dvander@232
   431
typedef void ( *D_FnChangeCallback )( D_ConVar *var, char const *pOldString );
dvander@232
   432
dvander@232
   433
class G_ConVar : public ConVar
dvander@232
   434
{
dvander@232
   435
public:
dvander@232
   436
	G_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL) {}
dvander@232
   437
	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString ) {}
dvander@232
   438
	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString, bMin, fMin, bMax, fMax) {}
dvander@232
   439
	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, G_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString, (FnChangeCallback)callback ) {}
dvander@232
   440
	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, G_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
dvander@232
   441
};
dvander@232
   442
dvander@232
   443
class C_ConVar : public ConVar
dvander@232
   444
{
dvander@232
   445
public:
dvander@232
   446
	C_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL) {}
dvander@232
   447
	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString ) {}
dvander@232
   448
	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString, bMin, fMin, bMax, fMax) {}
dvander@232
   449
	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, C_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString, (FnChangeCallback)callback ) {}
dvander@232
   450
	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, C_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
dvander@232
   451
};
dvander@232
   452
dvander@232
   453
class M_ConVar : public ConVar
dvander@232
   454
{
dvander@232
   455
public:
dvander@232
   456
	M_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM) {}
dvander@232
   457
	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString ) {}
dvander@232
   458
	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString, bMin, fMin, bMax, fMax) {}
dvander@232
   459
	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString, (FnChangeCallback)callback ) {}
dvander@232
   460
	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
dvander@232
   461
};
dvander@232
   462
dvander@232
   463
class S_ConVar : public ConVar
dvander@232
   464
{
dvander@232
   465
public:
dvander@232
   466
	S_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER) {}
dvander@232
   467
	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString ) {}
dvander@232
   468
	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString, bMin, fMin, bMax, fMax) {}
dvander@232
   469
	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString, (FnChangeCallback)callback ) {}
dvander@232
   470
	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, S_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
dvander@232
   471
};
dvander@232
   472
dvander@232
   473
class D_ConVar : public ConVar
dvander@232
   474
{
dvander@232
   475
public:
dvander@232
   476
	D_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE) {}
dvander@232
   477
	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString ) {}
dvander@232
   478
	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString, bMin, fMin, bMax, fMax) {}
dvander@232
   479
	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString, (FnChangeCallback)callback ) {}
dvander@232
   480
	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, D_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
dvander@232
   481
};
dvander@232
   482
dvander@232
   483
// redirect these declarations to their specific subsystem
dvander@232
   484
#ifdef GAME_DLL
dvander@232
   485
#define ConCommand	G_ConCommand
dvander@232
   486
#define ConVar		G_ConVar
dvander@232
   487
#endif
dvander@232
   488
#ifdef CLIENT_DLL
dvander@232
   489
#define ConCommand	C_ConCommand
dvander@232
   490
#define ConVar		C_ConVar
dvander@232
   491
#endif
dvander@232
   492
#ifdef MATERIALSYSTEM_DLL
dvander@232
   493
#define ConCommand	M_ConCommand
dvander@232
   494
#define ConVar		M_ConVar
dvander@232
   495
#endif
dvander@232
   496
#ifdef STUDIORENDER_DLL
dvander@232
   497
#define ConCommand	S_ConCommand
dvander@232
   498
#define ConVar		S_ConVar
dvander@232
   499
#endif
dvander@232
   500
#ifdef DATACACHE_DLL
dvander@232
   501
#define ConCommand	D_ConCommand
dvander@232
   502
#define ConVar		D_ConVar
dvander@232
   503
#endif
dvander@232
   504
#endif // _STATIC_LINKED
dvander@232
   505
dvander@76
   506
//-----------------------------------------------------------------------------
dvander@76
   507
// Purpose: Utility to quicky generate a simple console command
dvander@76
   508
//-----------------------------------------------------------------------------
dvander@76
   509
#define CON_COMMAND( name, description ) \
dvander@76
   510
   static void name(); \
dvander@76
   511
   static ConCommand name##_command( #name, name, description ); \
dvander@76
   512
   static void name()
dvander@76
   513
dvander@76
   514
//-----------------------------------------------------------------------------
dvander@76
   515
// Purpose: Utility to quicky generate a simple console command
dvander@76
   516
//-----------------------------------------------------------------------------
dvander@76
   517
#define CON_COMMAND_F( name, description, flags ) \
dvander@76
   518
   static void name(); \
dvander@76
   519
   static ConCommand name##_command( #name, name, description, flags ); \
dvander@76
   520
   static void name()
dvander@76
   521
dvander@76
   522
dvander@76
   523
#endif // CONVAR_H