Blamite Game Engine - blam!  00296.01.12.21.0102.blamite
The core library for the Blamite Game Engine.
screenshot.hpp
Go to the documentation of this file.
1 #include "../console.h"
3 
5 {
13  {
14  public:
16  {
17  name = "screenshot";
18  description = "Captures the current frame onscreen to a file, with an optional filename. If no filename is provided, a default filename is used.";
19  syntax = "screenshot [string]";
20  aliases = { "duigvs" };
21 
23  }
24 
25  BlamCommandResult onCommand(std::vector<std::string> arguments)
26  {
27  Blam::Logger::LogEventForce("not yet implemented", WSV_NONE);
28 
29  return BlamCommandResult::Ok;
30  }
31  };
32 }
BlamConsoleCommand::description
std::string description
An optional description of the command. Shown when using the classify command.
Definition: console.h:57
logger.h
Blam::Resources::Console::ScreenshotCommand
Class for the screenshot command.
Definition: screenshot.hpp:12
BlamCommandResult::Ok
@ Ok
The command was run without error.
BlamConsoleCommand
Class used to represent a console command.
Definition: console.h:54
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
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
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.
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::ScreenshotCommand::onCommand
BlamCommandResult onCommand(std::vector< std::string > arguments)
Called upon command execution.
Definition: screenshot.hpp:25
Blam::Resources::Console::ScreenshotCommand::ScreenshotCommand
ScreenshotCommand()
Definition: screenshot.hpp:15
Blam::Resources::Console
Namespace for things relating to the debug console.
Definition: abort.hpp:5