Elaztek Developer Hub
Switch Project...
Blamite Game Engine - blam!  00423.10.27.24.0533.blamite
The core library for the Blamite Game Engine.
keystone.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <Windows.h>
4 #include <string>
5 
6 #include "components/diagnostics/errors/errors.h"
7 
8 #ifndef BLAM
9 #define BLAM
10 #endif
11 
15 namespace Blam::Modules::Keystone
16 {
23  BLAM BlamResult SetupModule();
24 
28  BLAM void ShutdownModule();
29 
35  BLAM HMODULE GetKeystoneModuleHandle();
36 
46  BLAM int ShowErrorDialog(bool allow_safemode, bool allow_continue, const char* text);
47 
54  BLAM bool ShowEngineFirstbootDialog();
55 }
variable_type::int
@ int
ENGINE_CFG_SECTION
#define ENGINE_CFG_SECTION(section_name)
Macro to quickly access a configuration section from the engine configuration file.
Definition: config.h:27
Blam::Logger::Queue::AddMessage
BLAM void AddMessage(BlamLogMessage message)
Adds a message to the queue.
Definition: queue.cpp:77
Blam::Logger::LogEvent
BLAM void LogEvent(std::string message)
Logs a message to the log and/or console.
Definition: aliases.cpp:130
bypass_queue
bool bypass_queue
Whether or not to ignore the queue after initial startup.
Definition: queue.cpp:24
BlamReport
Class representing a report file.
Definition: logger.h:140
Blam::Logger::GetLogLevelColor
BLAM BlamColor GetLogLevelColor(BlamLogLevel log_level)
Retrieves the BlamColor that a specific log level should display with.
Definition: aliases.cpp:12
flush_thread_stopped
volatile bool flush_thread_stopped
Definition: queue.cpp:29
keystone_handle
HMODULE keystone_handle
The module handle of the Keystone library.
Definition: keystone.cpp:8
logger.h
use_reports
bool use_reports
Whether or not logs are being written to multiple report files.
Definition: queue.cpp:26
last_log_message
std::string last_log_message
Stores the text of the most recent log message. Used to check for duplicates.
Definition: queue.cpp:18
keystone.h
message_queue
std::vector< BlamLogMessage > message_queue
Queue of any log messages that need to be written to console and/or log files.
Definition: queue.cpp:15
Blam::Logger::Queue::StopFlushThread
BLAM void StopFlushThread()
Stops the logger queue flush thread.
Definition: queue.cpp:236
load_keystone_function
BlamResult load_keystone_function(T *function_callback, const char *function_name)
Definition: keystone.cpp:20
engine_text.h
Blam::Tick::MaxTicksPerSecond
BLAM int MaxTicksPerSecond()
Retrieves the maximum number of ticks per second.
Definition: tick.cpp:208
Blam::Diagnostics::Errors::ShowWin32ErrorDialog
BLAM int ShowWin32ErrorDialog(std::string message, BlamResult error, bool allow_continue, bool allow_safemode)
Shows an Error dialog with the specified error details and result handle.
Definition: errors.cpp:139
__Keystone_ShowEngineFirstbootDialog
_ShowEngineFirstbootDialog __Keystone_ShowEngineFirstbootDialog
Definition: keystone.cpp:18
Blam::Logger::Queue::GetQueue
BLAM std::vector< BlamLogMessage > * GetQueue()
Retrieves the current message queue.
Definition: queue.cpp:210
Blam::Modules::Keystone::ShutdownModule
BLAM void ShutdownModule()
Shuts down the module and releases any data used by it.
Definition: keystone.cpp:73
duplicate_count
int duplicate_count
The number of duplicate messages recieved.
Definition: queue.cpp:20
variable_type::bool
@ bool
uint64_t
unsigned long long uint64_t
Definition: stdint.h:18
errors.h
_Initialize
void(CALLBACK * _Initialize)()
Definition: keystone.cpp:10
tick.h
Blam::Tick::GetTotalRuntimeTicks
BLAM uint64_t GetTotalRuntimeTicks()
Gets the total amount of ticks that have elapsed during program runtime.
Definition: tick.cpp:233
NULL
Add a fourth parameter to bake specific font ranges NULL
Definition: README.txt:57
run_flush_thread
volatile bool run_flush_thread
Definition: queue.cpp:28
BLAM
#define BLAM
Definition: keystone.h:9
Blam::Modules::Keystone::ShowEngineFirstbootDialog
BLAM bool ShowEngineFirstbootDialog()
Shows the engine first boot notice dialog.
Definition: keystone.cpp:93
_ShowEngineFirstbootDialog
bool(CALLBACK * _ShowEngineFirstbootDialog)()
Definition: keystone.cpp:13
__Keystone_ShowErrorDialog
_ShowErrorDialog __Keystone_ShowErrorDialog
Definition: keystone.cpp:17
__Keystone_Initialize
_Initialize __Keystone_Initialize
Definition: keystone.cpp:15
BlamReport::LogEvent
bool LogEvent(BlamLogMessage message)
Writes a message to the log file, console, and/or STDOUT depending on the message.
Definition: BlamReport.cpp:77
Blam::Logger::Queue::Flush
BLAM void Flush()
Flushes the queue, causing all messages to be written to all places they are configured to do so.
Definition: queue.cpp:45
BlamReport::IsReady
bool IsReady()
Whether or not the report is ready for use.
Definition: BlamReport.cpp:174
Blam::Modules::Keystone::SetupModule
BLAM BlamResult SetupModule()
Sets up the module and loads all necessary functions for calling.
Definition: keystone.cpp:39
max_errors_before_supression
int max_errors_before_supression
Controls the maximum amount of error messages shown before they are suppressed from the in-game conso...
Definition: queue.cpp:25
last_duplicate_message_tick
uint64_t last_duplicate_message_tick
The tick number when the last duplicate message was received. Not yet used.
Definition: queue.cpp:21
Blam::Modules::Keystone
Namespace containing functions from the Keystone library.
Definition: keystone.h:15
Blam::Logger::Queue::Shutdown
BLAM void Shutdown()
Flushes the queue and may later be used to perform other shutdown tasks.
Definition: queue.cpp:39
Blam::API::v1::Hooking::GetEngineHookState
BLAM_EXT_API bool GetEngineHookState()
Retrieves the engine's hook state.
Definition: hooking.cpp:14
_Shutdown
void(CALLBACK * _Shutdown)()
Definition: keystone.cpp:11
__Keystone_Shutdown
_Shutdown __Keystone_Shutdown
Definition: keystone.cpp:16
suppress_duplicates
bool suppress_duplicates
Whether or not to continue suppressing log messages.
Definition: queue.cpp:19
Blam::Modules::Keystone::GetKeystoneModuleHandle
BLAM HMODULE GetKeystoneModuleHandle()
Retrieves the module handle for the Keystone library.
Definition: keystone.cpp:83
ENGINE_TEXT
#define ENGINE_TEXT(string_id)
Definition: engine_text.h:7
Blam::Logger::Queue::StartFlushThread
BLAM void StartFlushThread()
Starts the logger queue flush thread.
Definition: queue.cpp:231
Blam::Logger::GetReports
BLAM std::vector< BlamReport * > GetReports()
Retrieves the list of reports.
Definition: logger.cpp:207
last_flush_time
uint64_t last_flush_time
Definition: queue.cpp:30
Blam::Modules::Keystone::ShowErrorDialog
BLAM int ShowErrorDialog(bool allow_safemode, bool allow_continue, const char *text)
Shows a Qt-driven error dialog.
Definition: keystone.cpp:88
config.h
_ShowErrorDialog
int(CALLBACK * _ShowErrorDialog)(bool allow_safemode, bool allow_continue, const char *text)
Definition: keystone.cpp:12
duplicate_tick_timeout
int duplicate_tick_timeout
Definition: queue.cpp:22
Blam::Logger::Queue::FlushThread
BLAM void FlushThread()
Function for the logger queue flush thread.
Definition: queue.cpp:215
Blam::EngineText::LookupErrorString
BLAM std::string LookupErrorString(int error_code)
Finds a string message associated with a given error code.
Definition: engine_text.cpp:46
Blam::Logger::Queue::Initialize
BLAM void Initialize()
Initializes the logger queue.
Definition: queue.cpp:32
Blam::Logger::GetReport
BLAM BlamReport * GetReport(BlamReportType type)
Retrieves report data with the specified type.
Definition: logger.cpp:177
api.h
lock
volatile bool lock
Whether or not the queue is currently locked to aid in thread safety.
Definition: queue.cpp:17