Script2Game::ConsoleClass Class Reference

Binding of RoR::Console; provides console variables (cvars), usually defined in RoR.cfg file. More...

#include <ConsoleClass.h>

Public Member Functions
CVar *	cVarCreate (std::string const &name, std::string const &long_name, int flags, std::string const &val=std::string())
	Add CVar and parse default value if specified. More...
void	cVarAssign (CVar *cvar, std::string const &value)
	Parse value by cvar type. More...
CVar *	cVarFind (std::string const &input_name)
	Find cvar by short/long name. More...
CVar *	cVarSet (std::string const &input_name, std::string const &input_val)
	Set existing cvar by short/long name. More...
CVar *	cVarGet (std::string const &input_name, int flags)
	Get cvar by short/long name, or create new one using input as short name. More...

Detailed Description

Binding of RoR::Console; provides console variables (cvars), usually defined in RoR.cfg file.

Note

This object is created automatically as global variable console.

Definition at line 16 of file ConsoleClass.h.

Member Function Documentation

cVarAssign()

void Script2Game::ConsoleClass::cVarAssign	(	CVar *	cvar,
		std::string const &	value
	)

Parse value by cvar type.

cVarCreate()

CVar* Script2Game::ConsoleClass::cVarCreate	(	std::string const &	name,
		std::string const &	long_name,
		int	flags,
		std::string const &	val = std::string()
	)

Add CVar and parse default value if specified.

cVarFind()

CVar* Script2Game::ConsoleClass::cVarFind

(

std::string const &

input_name

)

Find cvar by short/long name.

cVarGet()

CVar* Script2Game::ConsoleClass::cVarGet	(	std::string const &	input_name,
		int	flags
	)

Get cvar by short/long name, or create new one using input as short name.

cVarSet()

CVar* Script2Game::ConsoleClass::cVarSet	(	std::string const &	input_name,
		std::string const &	input_val
	)

Set existing cvar by short/long name.

Return the modified cvar (or NULL if not found)

---

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

• doc/angelscript/Script2Game/ConsoleClass.h