Blamite Game Engine - blam!  00272.10.26.20.0001.blamite
The core library for the Blamite Game Engine.
Blam::Console::ShowStatsCommand Class Reference

Class for the show_stats command. More...

#include <show_stats.hpp>

+ Inheritance diagram for Blam::Console::ShowStatsCommand:

Public Member Functions

 ShowStatsCommand ()
 
 ~ShowStatsCommand ()
 
CommandStatus onCommand (std::vector< std::string > arguments)
 Called upon command execution. More...
 
- Public Member Functions inherited from Blam::Console::ConsoleCommand
 ConsoleCommand ()
 Unused constructor. More...
 
 ~ConsoleCommand ()
 Unused destructor. More...
 

Additional Inherited Members

- Public Attributes inherited from Blam::Console::ConsoleCommand
std::string name
 The name of the console command. More...
 
std::string description
 An optional description of the command. Shown when using the classify command. More...
 
std::string syntax
 The syntax information for the command. Shown to the user when using the help command with an argument. More...
 
std::vector< std::string > aliases
 A list of aliases for the command. Executing any of these instead of the command name will behave the same. More...
 
CommandType type
 The type of command this is. See Blam::Console::CommandType for more information. More...
 

Detailed Description

Class for the show_stats command.

A legacy command from the ImGUI console which toggled the stats display. The display includes FPS, pointer location, frame times, and other information. The stats UI has not been reimplemented, and as such this command does not currently do anything.

Todo:
make the command do something and reimplement stats

Constructor & Destructor Documentation

◆ ShowStatsCommand()

Blam::Console::ShowStatsCommand::ShowStatsCommand ( )
inline

◆ ~ShowStatsCommand()

Blam::Console::ShowStatsCommand::~ShowStatsCommand ( )
inline

Member Function Documentation

◆ onCommand()

CommandStatus Blam::Console::ShowStatsCommand::onCommand ( std::vector< std::string >  arguments)
inlinevirtual

Called upon command execution.

Parameters
arguments- The list of arguments passed to the command. Any space character in the command line is treated as a new argument.
Returns
The status of the command execution. See Blam::Console::CommandStatus for details.

Reimplemented from Blam::Console::ConsoleCommand.


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