RoR::ConsoleCmd Class Reference

Description

Base (abstract) console command.

Definition at line 37 of file ConsoleCmd.h.

Inheritance diagram for RoR::ConsoleCmd:

Public Member Functions
	ConsoleCmd (std::string const &name, std::string const &usage, std::string const &doc)
virtual	~ConsoleCmd ()
virtual void	Run (Ogre::StringVector const &args)=0
std::string const &	getName () const
std::string const &	GetUsage () const
std::string const &	GetDoc () const

Protected Member Functions
bool	CheckAppState (AppState state)

Protected Attributes
std::string	m_name
std::string	m_usage
std::string	m_doc

Constructor & Destructor Documentation

ConsoleCmd()

RoR::ConsoleCmd::ConsoleCmd ( std::string const &  name, std::string const &  usage, std::string const &  doc  )

inline

Definition at line 40 of file ConsoleCmd.h.

~ConsoleCmd()

virtual RoR::ConsoleCmd::~ConsoleCmd ( )

inlinevirtual

Definition at line 43 of file ConsoleCmd.h.

Member Function Documentation

GetDoc()

std::string const & RoR::ConsoleCmd::GetDoc ( ) const

inline

Definition at line 49 of file ConsoleCmd.h.

getName()

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

inline

Definition at line 47 of file ConsoleCmd.h.

GetUsage()

std::string const & RoR::ConsoleCmd::GetUsage ( ) const

inline

Definition at line 48 of file ConsoleCmd.h.

Run()

virtual void RoR::ConsoleCmd::Run ( Ogre::StringVector const &  args )

pure virtual

Implemented in GravityCmd, WaterlevelCmd, TerrainheightCmd, SpawnobjectCmd, LogCmd, VerCmd, PosCmd, GotoCmd, AsCmd, SpeedOfSoundCmd, QuitCmd, HelpCmd, LoadScriptCmd, LoadServerScriptCmd, UnloadServerScriptCmd, VarsCmd, SetCmd, SetCVarCmd, and ClearCmd.

Field Documentation

m_doc

std::string RoR::ConsoleCmd::m_doc

protected

Definition at line 56 of file ConsoleCmd.h.

m_name

std::string RoR::ConsoleCmd::m_name

protected

Definition at line 54 of file ConsoleCmd.h.

m_usage

std::string RoR::ConsoleCmd::m_usage

protected

Definition at line 55 of file ConsoleCmd.h.

---

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

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