Blamite Game Engine - Blam (Core)
classify.hpp
Go to the documentation of this file.
1 #include "../console.h"
3 #include "core.h"
5 
6 namespace Blam::Console
7 {
14  {
15  public:
17  {
18  name = "classify";
19  description = "Provides information on a command";
20  aliases = { "man" };
21 
23  }
24 
29  {
30  delete this;
31  }
32 
33  CommandStatus onCommand(std::vector<std::string> arguments)
34  {
35  if (arguments.size() == 0)
36  {
38  }
39  else
40  {
41  ConsoleCommand* cmd = Blam::Console::GetCommand(arguments[0]);
42 
43  if (cmd)
44  {
47  if (cmd->aliases.size() > 0)
48  {
49  std::string aliases = "";
50 
51  for (int i = 0; i < cmd->aliases.size(); i++)
52  {
53  if (i == cmd->aliases.size() - 1)
54  {
55  aliases += cmd->aliases[i];
56  }
57  else
58  {
59  aliases += cmd->aliases[i] + ", ";
60  }
61  }
62 
64  }
65  }
66  else
67  {
68  return CMD_ERR_INVALID_ARGS;
69  }
70  }
71 
72  return CMD_OK;
73  }
74  };
75 }
Blam::Console::ConsoleCommand::aliases
std::vector< std::string > aliases
A list of aliases for the command. Executing any of these instead of the command name will behave the...
Definition: console.h:75
Blam::Console::ConsoleCommand::description
std::string description
An optional description of the command. Shown when using the classify command.
Definition: console.h:73
CMD_ERR_WRONG_ARGS_COUNT
#define CMD_ERR_WRONG_ARGS_COUNT
Macro for Wrong Arg Count command status. See Blam::Console::WrongArgumentCount for more details.
Definition: console.h:11
Blam::Console::ConsoleCommand::type
CommandType type
The type of command this is. See Blam::Console::CommandType for more information.
Definition: console.h:77
Blam::Console::CommandStatus
CommandStatus
Indicates the return state of a console command.
Definition: console.h:28
logger.h
Blam::Console::ClassifyCommand::~ClassifyCommand
~ClassifyCommand()
Destructor has my favorite line of code in the world - delete this;
Definition: classify.hpp:28
debug_colors.h
Blam::Console::ClassifyCommand
Class for the classify command.
Definition: classify.hpp:13
Blam::Console::Builtin
@ Builtin
A command that is hard-coded into the engine.
Definition: console.h:41
Blam::Console::ConsoleCommand::name
std::string name
The name of the console command.
Definition: console.h:70
Blam::Console::GetCommand
BLAM ConsoleCommand * GetCommand(std::string name)
Retrieves a command with the specified name.
Definition: console.cpp:155
WSV_NONE
#define WSV_NONE
Macro for 'None' log seveirty. Original pre-enum value was 0.
Definition: logger.h:15
Blam::Console
Namespace for things relating to the debug console.
Definition: abort.hpp:5
Blam::Console::ConsoleCommand
Class used to represent a console command.
Definition: console.h:50
Blam::Logger::LogEventForce
BLAM void LogEventForce(std::string message, LogSeverity severity)
Forcibly logs a message to the log and/or console.
Definition: aliases.cpp:137
CMD_OK
#define CMD_OK
Macro for OK command status. See Blam::Console::Ok for more details.
Definition: console.h:9
core.h
Blam::Console::ClassifyCommand::ClassifyCommand
ClassifyCommand()
Definition: classify.hpp:16
InternalUI::Colors::GetNamedColor
BLAM BlamColor * GetNamedColor(std::string id)
Retrieves a color by its ID.
Definition: debug_ui_colors.cpp:7
CMD_ERR_INVALID_ARGS
#define CMD_ERR_INVALID_ARGS
Macro for Invalid Args command status. See Blam::Console::InvalidArguments for more details.
Definition: console.h:10
Blam::Console::ClassifyCommand::onCommand
CommandStatus onCommand(std::vector< std::string > arguments)
Called upon command execution.
Definition: classify.hpp:33