RoR::CVar Class Reference

Quake-style console variable, defined in RoR.cfg or crated via Console UI and scripts. More...

#include <CVar.h>

Public Member Functions
	CVar (std::string const &name, std::string const &long_name, int flags)
template<typename T >
void	setVal (T val)
void	setStr (std::string const &str)
std::string const &	getStr () const
float	getFloat () const
int	getInt () const
bool	getBool () const
template<typename T >
T	getEnum () const
std::string const &	getName () const
std::string const &	getLongName () const
bool	hasFlag (int f) const

Private Member Functions
void	logUpdate (std::string const &new_val)
std::string	convertStr (float val)

Private Attributes
std::string	m_name
std::string	m_long_name
std::string	m_value_str
float	m_value_num
int	m_flags

Detailed Description

Quake-style console variable, defined in RoR.cfg or crated via Console UI and scripts.

Inspired by Quake II:

• Struct: https://github.com/yquake2/yquake2/blob/master/src/common/header/shared.h#L332
• Functions: https://github.com/yquake2/yquake2/blob/master/src/common/cvar.c
• Global var: https://github.com/yquake2/yquake2/blob/master/src/common/header/common.h#L432

Author

Petr Ohlidal, 2020

Definition at line 52 of file CVar.h.

Constructor & Destructor Documentation

CVar()

RoR::CVar::CVar ( std::string const &  name, std::string const &  long_name, int  flags  )

inline

Definition at line 56 of file CVar.h.

Member Function Documentation

convertStr()

std::string CVar::convertStr ( float  val )

private

Definition at line 318 of file CVar.cpp.

getBool()

bool RoR::CVar::getBool ( ) const

inline

Definition at line 98 of file CVar.h.

getEnum()

template<typename T >

T RoR::CVar::getEnum ( ) const

inline

Definition at line 99 of file CVar.h.

getFloat()

float RoR::CVar::getFloat ( ) const

inline

Definition at line 96 of file CVar.h.

getInt()

int RoR::CVar::getInt ( ) const

inline

Definition at line 97 of file CVar.h.

getLongName()

std::string const & RoR::CVar::getLongName ( ) const

inline

Definition at line 104 of file CVar.h.

getName()

std::string const & RoR::CVar::getName ( ) const

inline

Definition at line 103 of file CVar.h.

getStr()

std::string const & RoR::CVar::getStr ( ) const

inline

Definition at line 95 of file CVar.h.

hasFlag()

bool RoR::CVar::hasFlag ( int  f ) const

inline

Definition at line 105 of file CVar.h.

logUpdate()

void CVar::logUpdate ( std::string const &  new_val )

private

Definition at line 306 of file CVar.cpp.

setStr()

void RoR::CVar::setStr ( std::string const &  str )

inline

Definition at line 83 of file CVar.h.

setVal()

template<typename T >

void RoR::CVar::setVal ( T  val )

inline

Definition at line 72 of file CVar.h.

Field Documentation

m_flags

int RoR::CVar::m_flags

private

Definition at line 118 of file CVar.h.

m_long_name

std::string RoR::CVar::m_long_name

private

Definition at line 114 of file CVar.h.

m_name

std::string RoR::CVar::m_name

private

Definition at line 113 of file CVar.h.

m_value_num

float RoR::CVar::m_value_num

private

Definition at line 117 of file CVar.h.

m_value_str

std::string RoR::CVar::m_value_str

private

Definition at line 116 of file CVar.h.

---

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

• source/main/system/CVar.h
• source/main/system/CVar.cpp