Elaztek Developer Hub
Blamite Game Engine - blam!  00346.12.11.21.0529.blamite
The core library for the Blamite Game Engine.
h2help.hpp
Go to the documentation of this file.
1 #pragma once
2 
3 #include "../console.h"
4 
5 #include <set>
6 
8 
10 {
19  {
20  public:
22  {
23  name = "h2help";
24  description = "prints a description of the named function.";
25  syntax = "help <string>";
26  aliases = { "chelp" };
27 
29  }
30 
32  {
33  delete this;
34  }
35 
36  BlamCommandResult onCommand(std::vector<std::string> arguments)
37  {
38  if (arguments.size() == 0)
39  {
41  }
42  else
43  {
45 
46  if (cmd)
47  {
48  std::string title = "";
49 
50  if (cmd->syntax == "")
51  {
52  title = cmd->name;
53  }
54  else
55  {
56  title = cmd->syntax;
57  }
58 
59  Blam::Logger::LogEventForce("(" + title + ")", WSV_NONE);
61  }
62  else
63  {
64  return CMD_OK;
65  }
66  }
67 
68  return CMD_OK;
69  }
70  };
71 }
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:240
Blam::Resources::Console::Halo2HelpCommand
Class for the h2help command.
Definition: h2help.hpp:18
Blam::Resources::Console::Halo2HelpCommand::Halo2HelpCommand
Halo2HelpCommand()
Definition: h2help.hpp:21
BlamConsoleCommand::name
std::string name
The name of the console command.
Definition: console.h:56
Blam::Resources::Console::Halo2HelpCommand::~Halo2HelpCommand
~Halo2HelpCommand()
Definition: h2help.hpp:31
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
Blam::Logger::LogEventForce
BLAM void LogEventForce(std::string message)
Forcibly logs a message to the log and/or console.
Definition: aliases.cpp:258
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:36
Blam::Resources::Console
Namespace for things relating to the debug console.
Definition: abort.hpp:5