SStringConfigVariable Struct Reference

#include <config.h>

Inheritance diagram for SStringConfigVariable:

Collaboration diagram for SStringConfigVariable:

Public Member Functions
	SStringConfigVariable (IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp, char *pStr, const char *pDefault, size_t MaxSize, char *pOldValue)
	~SStringConfigVariable () override=default
void	Register () override
bool	IsDefault () const override
void	Serialize (char *pOut, size_t Size, const char *pValue) const
void	Serialize (char *pOut, size_t Size) const override
void	SetValue (const char *pValue)
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
char *	m_pStr
const char *	m_pDefault
size_t	m_MaxSize
char *	m_pOldValue
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

SStringConfigVariable()

SStringConfigVariable::SStringConfigVariable	(	IConsole *	pConsole,
		const char *	pScriptName,
		EVariableType	Type,
		int	Flags,
		const char *	pHelp,
		char *	pStr,
		const char *	pDefault,
		size_t	MaxSize,
		char *	pOldValue
	)

~SStringConfigVariable()

SStringConfigVariable::~SStringConfigVariable ( )

overridedefault

Member Function Documentation

CommandCallback()

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

static

IsDefault()

bool SStringConfigVariable::IsDefault ( ) const

overridevirtual

Implements SConfigVariable.

Register()

void SStringConfigVariable::Register ( )

overridevirtual

Implements SConfigVariable.

ResetToDefault()

void SStringConfigVariable::ResetToDefault ( )

overridevirtual

Implements SConfigVariable.

ResetToOld()

void SStringConfigVariable::ResetToOld ( )

overridevirtual

Implements SConfigVariable.

Serialize() [1/2]

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

overridevirtual

Implements SConfigVariable.

Serialize() [2/2]

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

SetValue()

void SStringConfigVariable::SetValue

(

const char *

pValue

)

Member Data Documentation

m_MaxSize

size_t SStringConfigVariable::m_MaxSize

m_pDefault

const char* SStringConfigVariable::m_pDefault

m_pOldValue

char* SStringConfigVariable::m_pOldValue

m_pStr

char* SStringConfigVariable::m_pStr

---

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

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