SConfigVariable Struct Reference

#include <config.h>

Inheritance diagram for SConfigVariable:

Collaboration diagram for SConfigVariable:

Public Types
enum	EVariableType { VAR_INT , VAR_COLOR , VAR_STRING }

Public Member Functions
	SConfigVariable (IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp)
virtual	~SConfigVariable ()=default
virtual void	Register ()=0
virtual bool	IsDefault () const =0
virtual void	Serialize (char *pOut, size_t Size) const =0
virtual void	ResetToDefault ()=0
virtual void	ResetToOld ()=0

Public Attributes
IConsole *	m_pConsole
const char *	m_pScriptName
EVariableType	m_Type
int	m_Flags
const char *	m_pHelp
bool	m_ReadOnly = false

Protected Member Functions
void	ExecuteLine (const char *pLine) const
bool	CheckReadOnly () const

Member Enumeration Documentation

EVariableType

enum SConfigVariable::EVariableType

Enumerator
VAR_INT
VAR_COLOR
VAR_STRING

Constructor & Destructor Documentation

SConfigVariable()

SConfigVariable::SConfigVariable ( IConsole * pConsole, const char * pScriptName, EVariableType Type, int Flags, const char * pHelp )

inline

~SConfigVariable()

virtual SConfigVariable::~SConfigVariable ( )

virtualdefault

Member Function Documentation

CheckReadOnly()

bool SConfigVariable::CheckReadOnly ( ) const

protected

ExecuteLine()

void SConfigVariable::ExecuteLine ( const char * pLine ) const

protected

IsDefault()

virtual bool SConfigVariable::IsDefault ( ) const

pure virtual

Implemented in SColorConfigVariable, SIntConfigVariable, and SStringConfigVariable.

Register()

virtual void SConfigVariable::Register ( )

pure virtual

Implemented in SColorConfigVariable, SIntConfigVariable, and SStringConfigVariable.

ResetToDefault()

virtual void SConfigVariable::ResetToDefault ( )

pure virtual

Implemented in SColorConfigVariable, SIntConfigVariable, and SStringConfigVariable.

ResetToOld()

virtual void SConfigVariable::ResetToOld ( )

pure virtual

Implemented in SColorConfigVariable, SIntConfigVariable, and SStringConfigVariable.

Serialize()

virtual void SConfigVariable::Serialize ( char * pOut, size_t Size ) const

pure virtual

Implemented in SColorConfigVariable, SIntConfigVariable, and SStringConfigVariable.

Member Data Documentation

m_Flags

int SConfigVariable::m_Flags

m_pConsole

IConsole* SConfigVariable::m_pConsole

m_pHelp

const char* SConfigVariable::m_pHelp

m_pScriptName

const char* SConfigVariable::m_pScriptName

m_ReadOnly

bool SConfigVariable::m_ReadOnly = false

m_Type

EVariableType SConfigVariable::m_Type

---

The documentation for this struct was generated from the following files:

• src/engine/shared/config.h
• src/engine/shared/config.cpp