DtConsoleCommand Class Reference

system includes More...

Inheritance diagram for DtConsoleCommand:

Public Member Functions
virtual	~DtConsoleCommand ()
virtual bool	execute (const DtString &parameters)=0
	Execute the command.
virtual DtString	help (const DtString &parameters)
virtual bool	showInHelp () const

Detailed Description

system includes

Abstract base class for all commands registered with the DtConsoleCommandManager.

Constructor & Destructor Documentation

virtual DtConsoleCommand::~DtConsoleCommand ( )

inlinevirtual

Member Function Documentation

virtual bool DtConsoleCommand::execute ( const DtString &  parameters )

pure virtual

Execute the command.

Returns

True on success of the command.

Implemented in DtExpireOlderThanCommand, DtSubCommandManager::DtRunSubCommand, DtGenerateTaskSetLuaDocCommand, DtConsoleCommandManager::DtNotifyLevelCommand, DtConsoleCommandManager::DtHelpConsoleCommand, DtCollisionObjectCountsCommand, DtSaveSimTerrainCommand, DtPageOutAllTerrainCommand, DtPrintBoundingVolumesCommand, DtSetDrawingModeCommand, and DtPrintSceneGraphCommand.

virtual DtString DtConsoleCommand::help ( const DtString &  parameters )

inlinevirtual

Returns

Some help text for the command.

Reimplemented in DtExpireOlderThanCommand, DtSubCommandManager::DtRunSubCommand, DtGenerateTaskSetLuaDocCommand, DtConsoleCommandManager::DtNotifyLevelCommand, DtConsoleCommandManager::DtHelpConsoleCommand, DtCollisionObjectCountsCommand, DtSaveSimTerrainCommand, DtPageOutAllTerrainCommand, DtPrintBoundingVolumesCommand, DtSetDrawingModeCommand, and DtPrintSceneGraphCommand.

virtual bool DtConsoleCommand::showInHelp ( ) const

inlinevirtual

Returns

True if this command should show up in the help list. If false, than this command will not be presented to the user.

Reimplemented in DtExpireOlderThanCommand, DtSubCommandManager::DtRunSubCommand, DtGenerateTaskSetLuaDocCommand, DtConsoleCommandManager::DtNotifyLevelCommand, DtConsoleCommandManager::DtHelpConsoleCommand, DtCollisionObjectCountsCommand, DtSaveSimTerrainCommand, DtPageOutAllTerrainCommand, DtPrintBoundingVolumesCommand, DtSetDrawingModeCommand, and DtPrintSceneGraphCommand.

---

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

• include/vrfutil/consoleCommandManager.h