mirror of
https://github.com/alliedmodders/hl2sdk.git
synced 2024-12-23 01:59:43 +08:00
121 lines
4.6 KiB
C++
121 lines
4.6 KiB
C++
//===== Copyright © 1996-2005, Valve Corporation, All rights reserved. ======//
|
|
//
|
|
// Purpose:
|
|
//
|
|
//===========================================================================//
|
|
|
|
#ifndef ICVAR_H
|
|
#define ICVAR_H
|
|
#ifdef _WIN32
|
|
#pragma once
|
|
#endif
|
|
|
|
#include "appframework/IAppSystem.h"
|
|
#include "tier1/iconvar.h"
|
|
|
|
class ConCommandBase;
|
|
class ConCommand;
|
|
class ConVar;
|
|
class Color;
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// ConVars/ComCommands are marked as having a particular DLL identifier
|
|
//-----------------------------------------------------------------------------
|
|
typedef int CVarDLLIdentifier_t;
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Used to display console messages
|
|
//-----------------------------------------------------------------------------
|
|
abstract_class IConsoleDisplayFunc
|
|
{
|
|
public:
|
|
virtual void ColorPrint( const Color& clr, const char *pMessage ) = 0;
|
|
virtual void Print( const char *pMessage ) = 0;
|
|
virtual void DPrint( const char *pMessage ) = 0;
|
|
};
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Applications can implement this to modify behavior in ICvar
|
|
//-----------------------------------------------------------------------------
|
|
#define CVAR_QUERY_INTERFACE_VERSION "VCvarQuery001"
|
|
abstract_class ICvarQuery : public IAppSystem
|
|
{
|
|
public:
|
|
// Can these two convars be aliased?
|
|
virtual bool AreConVarsLinkable( const ConVar *child, const ConVar *parent ) = 0;
|
|
};
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: DLL interface to ConVars/ConCommands
|
|
//-----------------------------------------------------------------------------
|
|
abstract_class ICvar : public IAppSystem
|
|
{
|
|
public:
|
|
// Allocate a unique DLL identifier
|
|
virtual CVarDLLIdentifier_t AllocateDLLIdentifier() = 0;
|
|
|
|
// Register, unregister commands
|
|
virtual void RegisterConCommand( ConCommandBase *pCommandBase ) = 0;
|
|
virtual void UnregisterConCommand( ConCommandBase *pCommandBase ) = 0;
|
|
virtual void UnregisterConCommands( CVarDLLIdentifier_t id ) = 0;
|
|
|
|
// If there is a +<varname> <value> on the command line, this returns the value.
|
|
// Otherwise, it returns NULL.
|
|
virtual const char* GetCommandLineValue( const char *pVariableName ) = 0;
|
|
|
|
// Try to find the cvar pointer by name
|
|
virtual ConCommandBase *FindCommandBase( const char *name ) = 0;
|
|
virtual const ConCommandBase *FindCommandBase( const char *name ) const = 0;
|
|
virtual ConVar *FindVar ( const char *var_name ) = 0;
|
|
virtual const ConVar *FindVar ( const char *var_name ) const = 0;
|
|
virtual ConCommand *FindCommand( const char *name ) = 0;
|
|
virtual const ConCommand *FindCommand( const char *name ) const = 0;
|
|
|
|
// Get first ConCommandBase to allow iteration
|
|
virtual ConCommandBase *GetCommands( void ) = 0;
|
|
virtual const ConCommandBase *GetCommands( void ) const = 0;
|
|
|
|
// Install a global change callback (to be called when any convar changes)
|
|
virtual void InstallGlobalChangeCallback( FnChangeCallback_t callback ) = 0;
|
|
virtual void RemoveGlobalChangeCallback( FnChangeCallback_t callback ) = 0;
|
|
virtual void CallGlobalChangeCallbacks( ConVar *var, const char *pOldString, float flOldValue ) = 0;
|
|
|
|
// Install a console printer
|
|
virtual void InstallConsoleDisplayFunc( IConsoleDisplayFunc* pDisplayFunc ) = 0;
|
|
virtual void RemoveConsoleDisplayFunc( IConsoleDisplayFunc* pDisplayFunc ) = 0;
|
|
virtual void ConsoleColorPrintf( const Color& clr, const char *pFormat, ... ) const = 0;
|
|
virtual void ConsolePrintf( const char *pFormat, ... ) const = 0;
|
|
virtual void ConsoleDPrintf( const char *pFormat, ... ) const = 0;
|
|
|
|
// Reverts cvars which contain a specific flag
|
|
virtual void RevertFlaggedConVars( int nFlag ) = 0;
|
|
|
|
// Method allowing the engine ICvarQuery interface to take over
|
|
// A little hacky, owing to the fact the engine is loaded
|
|
// well after ICVar, so we can't use the standard connect pattern
|
|
virtual void InstallCVarQuery( ICvarQuery *pQuery ) = 0;
|
|
|
|
#if defined( _X360 )
|
|
virtual void PublishToVXConsole( ) = 0;
|
|
#endif
|
|
};
|
|
|
|
#define CVAR_INTERFACE_VERSION "VEngineCvar004"
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// These global names are defined by tier1.h, duplicated here so you
|
|
// don't have to include tier1.h
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// These are marked DLL_EXPORT for Linux.
|
|
DLL_EXPORT ICvar *cvar;
|
|
DLL_EXPORT ICvar *g_pCVar;
|
|
|
|
|
|
#endif // ICVAR_H
|