SColorConfigVariable Struct Reference

#include <config.h>

Inheritance diagram for SColorConfigVariable:

Collaboration diagram for SColorConfigVariable:

Public Member Functions
	SColorConfigVariable (IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp, unsigned *pVariable, unsigned Default)
	~SColorConfigVariable () override=default
void	Register () override
bool	IsDefault () const override
void	Serialize (char *pOut, size_t Size, unsigned Value) const
void	Serialize (char *pOut, size_t Size) const override
void	SetValue (unsigned Value)
void	ResetToDefault () override
void	ResetToOld () override
Public Member Functions inherited from SConfigVariable
	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

Static Public Member Functions
static void	CommandCallback (IConsole::IResult *pResult, void *pUserData)

Public Attributes
unsigned *	m_pVariable
unsigned	m_Default
float	m_DarkestLighting
bool	m_Alpha
unsigned	m_OldValue
Public Attributes inherited from SConfigVariable
IConsole *	m_pConsole
const char *	m_pScriptName
EVariableType	m_Type
int	m_Flags
const char *	m_pHelp
bool	m_ReadOnly = false

Additional Inherited Members
Public Types inherited from SConfigVariable
enum	EVariableType { VAR_INT , VAR_COLOR , VAR_STRING }
Protected Member Functions inherited from SConfigVariable
void	ExecuteLine (const char *pLine) const
bool	CheckReadOnly () const

Constructor & Destructor Documentation

SColorConfigVariable()

SColorConfigVariable::SColorConfigVariable ( IConsole *  pConsole, const char *  pScriptName, EVariableType  Type, int  Flags, const char *  pHelp, unsigned *  pVariable, unsigned  Default  )

inline

~SColorConfigVariable()

SColorConfigVariable::~SColorConfigVariable ( )

overridedefault

Member Function Documentation

CommandCallback()

void SColorConfigVariable::CommandCallback ( IConsole::IResult *  pResult, void *  pUserData  )

static

IsDefault()

bool SColorConfigVariable::IsDefault ( ) const

overridevirtual

Implements SConfigVariable.

Register()

void SColorConfigVariable::Register ( )

overridevirtual

Implements SConfigVariable.

ResetToDefault()

void SColorConfigVariable::ResetToDefault ( )

overridevirtual

Implements SConfigVariable.

ResetToOld()

void SColorConfigVariable::ResetToOld ( )

overridevirtual

Implements SConfigVariable.

Serialize() [1/2]

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

overridevirtual

Implements SConfigVariable.

Serialize() [2/2]

void SColorConfigVariable::Serialize	(	char *	pOut,
		size_t	Size,
		unsigned	Value
	)		const

SetValue()

void SColorConfigVariable::SetValue

(

unsigned

Value

)

Member Data Documentation

m_Alpha

bool SColorConfigVariable::m_Alpha

m_DarkestLighting

float SColorConfigVariable::m_DarkestLighting

m_Default

unsigned SColorConfigVariable::m_Default

m_OldValue

unsigned SColorConfigVariable::m_OldValue

m_pVariable

unsigned* SColorConfigVariable::m_pVariable

---

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

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