Blamite Game Engine - blam!  00296.01.12.21.0102.blamite
The core library for the Blamite Game Engine.
h2help.hpp
Go to the documentation of this file.
1 #include "../console.h"
2 
3 #include <set>
4 
6 
8 {
17  {
18  public:
20  {
21  name = "h2help";
22  description = "prints a description of the named function.";
23  syntax = "help <string>";
24  aliases = { "chelp" };
25 
27  }
28 
30  {
31  delete this;
32  }
33 
34  BlamCommandResult onCommand(std::vector<std::string> arguments)
35  {
36  if (arguments.size() == 0)
37  {
39  }
40  else
41  {
43 
44  if (cmd)
45  {
46  std::string title = "";
47 
48  if (cmd->syntax == "")
49  {
50  title = cmd->name;
51  }
52  else
53  {
54  title = cmd->syntax;
55  }
56 
57  Blam::Logger::LogEventForce("(" + title + ")", WSV_NONE);
59  }
60  else
61  {
62  return CMD_OK;
63  }
64  }
65 
66  return CMD_OK;
67  }
68  };
69 }
CMD_ERR_WRONG_ARGS_COUNT
#define CMD_ERR_WRONG_ARGS_COUNT
Macro for Wrong Arg Count command status. See #Blam::Resources::Console::WrongArgumentCount for more ...
Definition: console.h:10
BlamConsoleCommand::description
std::string description
An optional description of the command. Shown when using the classify command.
Definition: console.h:57
logger.h
BlamConsoleCommand
Class used to represent a console command.
Definition: console.h:54
Blam::Resources::Console::GetCommand
BLAM BlamConsoleCommand * GetCommand(std::string name)
Retrieves a command with the specified name.
Definition: console.cpp:176
Blam::Logger::LogEventForce
BLAM void LogEventForce(std::string message, BlamLogLevel severity)
Forcibly logs a message to the log and/or console.
Definition: aliases.cpp:218
Blam::Resources::Console::Halo2HelpCommand
Class for the h2help command.
Definition: h2help.hpp:16
Blam::Resources::Console::Halo2HelpCommand::Halo2HelpCommand
Halo2HelpCommand()
Definition: h2help.hpp:19
BlamConsoleCommand::name
std::string name
The name of the console command.
Definition: console.h:56
WSV_NONE
#define WSV_NONE
Macro for 'None' log seveirty. Original pre-enum value was 0.
Definition: logger.h:16
Blam::Resources::Console::Halo2HelpCommand::~Halo2HelpCommand
~Halo2HelpCommand()
Definition: h2help.hpp:29
BlamConsoleCommand::syntax
std::string syntax
The syntax information for the command. Shown to the user when using the help command with an argumen...
Definition: console.h:58
BlamConsoleCommand::type
BlamCommandType type
The type of command this is. See #Blam::Resources::Console::BlamCommandType for more information.
Definition: console.h:61
BlamCommandType::Builtin
@ Builtin
A command that is hard-coded into the engine.
CMD_OK
#define CMD_OK
Macro for OK command status. See #Blam::Resources::Console::Ok for more details.
Definition: console.h:8
BlamCommandResult
BlamCommandResult
Indicates the return state of a console command.
Definition: console.h:22
BlamConsoleCommand::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:59
Blam::Resources::Console::Halo2HelpCommand::onCommand
BlamCommandResult onCommand(std::vector< std::string > arguments)
Called upon command execution.
Definition: h2help.hpp:34
Blam::Resources::Console
Namespace for things relating to the debug console.
Definition: abort.hpp:5