R5Reloaded/r5sdk
1
0
Fork 0
mirror of https://github.com/Mauler125/r5sdk.git synced 2025-02-09 19:15:03 +01:00
Code Issues Packages Projects Releases Wiki Activity
r5sdk/r5dev/gameui/IConsole.h

122 lines
3.9 KiB
C
Raw Normal View History

Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
#pragma once
Console performance improvements and bug fixes * Heavily reduced string compares for coloring logs (the left overs require a dedicated hook, this is for the future) The new method uses a ImVec 4 constant containing the color obtained via a switch case by context, this is then out into the new CConLog structure where the loop in the console will now gather the colors directly from. Error/Warning use a single constant. * Fixed bugs in several log locations where the ostringstream was cleared before the emission causing double logs. * Added global log mutex to log wrappers that lacked those.
2022-05-09 02:20:07 +02:00
#ifndef DEDICATED
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
#include "common/sdkdefs.h"
#include "windows/resource.h"
struct CSuggest
{
CSuggest(const string& svName, int nFlags)
{
m_svName = svName;
m_nFlags = nFlags;
}
bool operator==(const string& a) const
{
return m_svName.compare(a) == 0;
}
bool operator<(const CSuggest& a) const
{
return m_svName < a.m_svName;
}
string m_svName;
int m_nFlags;
};
Console performance improvements and bug fixes * Heavily reduced string compares for coloring logs (the left overs require a dedicated hook, this is for the future) The new method uses a ImVec 4 constant containing the color obtained via a switch case by context, this is then out into the new CConLog structure where the loop in the console will now gather the colors directly from. Error/Warning use a single constant. * Fixed bugs in several log locations where the ostringstream was cleared before the emission causing double logs. * Added global log mutex to log wrappers that lacked those.
2022-05-09 02:20:07 +02:00
struct CConLog
{
CConLog(const string& svConLog, const ImVec4& imColor)
{
m_svConLog = svConLog;
m_imColor = imColor;
}
string m_svConLog;
ImVec4 m_imColor;
};
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
class CConsole
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
{
private:
///////////////////////////////////////////////////////////////////////////
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
char m_szInputBuf[512] = { 0 };
Update ImGui default theme
2022-01-28 12:56:51 +01:00
char m_szSummary[256] = { 0 };
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
const char* m_pszConsoleTitle = { 0 };
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
vector<string> m_vsvCommands;
vector<string> m_vsvHistory;
Optimizations + QoL improvements/cleanup * IConsole overlay now clears the oldest log entries to stay under the vector limit instead of clearing the whole vector. * IConsole code cleanup. * IBrowser code cleanup, reordered class methods. * Use ConVar utilities to get/set values for strings in IBrowser and IConsole. * New ConVar's for RUI console overlay to tweak colors.
2022-01-12 02:53:07 +01:00
int m_nHistoryPos = -1;
Console and Browser UX improvements * Log warnings * Improve style * Vector size is now controlled by ConVar instead * Keep current item in view when console is cleaning up the vector. This doesn't work ideally as its hard to keep track of the current item, and the scroll is a float. In the future it might be better to grab the first vertex of the center line on the console and track that perhaps.
2022-01-22 15:51:09 +01:00
int m_nScrollBack = 0;
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
ImGuiTextFilter m_itFilter;
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
bool m_bInitialized = false;
Update ImGui default theme
2022-01-28 12:56:51 +01:00
bool m_bDefaultTheme = false;
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
bool m_bReclaimFocus = false;
Optimizations + QoL improvements/cleanup * IConsole overlay now clears the oldest log entries to stay under the vector limit instead of clearing the whole vector. * IConsole code cleanup. * IBrowser code cleanup, reordered class methods. * Use ConVar utilities to get/set values for strings in IBrowser and IConsole. * New ConVar's for RUI console overlay to tweak colors.
2022-01-12 02:53:07 +01:00
bool m_bAutoScroll = true;
bool m_bScrollToBottom = false;
bool m_bCopyToClipBoard = false;
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
bool m_bSuggestActive = false;
bool m_bSuggestMoved = false;
Reset scroll position when AutoSuggest has updated
2022-01-20 00:24:41 +01:00
bool m_bSuggestUpdate = false;
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
int m_nSuggestPos = -1;
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
vector<CSuggest> m_vsvSuggest;
vector<MODULERESOURCE> m_vFlagIcons;
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
ImVec2 m_vecSuggestWindowPos;
ImVec2 m_vecSuggestWindowSize;
ImGuiInputTextFlags input_text_flags =
ImGuiInputTextFlags_AutoCaretEnd |
ImGuiInputTextFlags_CallbackCompletion |
ImGuiInputTextFlags_CallbackHistory |
Update ImGui default theme
2022-01-28 12:56:51 +01:00
ImGuiInputTextFlags_CallbackAlways |
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
ImGuiInputTextFlags_CallbackEdit |
ImGuiInputTextFlags_EnterReturnsTrue;
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
ImGuiWindowFlags popup_window_flags =
Clamp Autocomplete window properly * Fixed cases where the horizontal scrollbar would conceal the only item in the autocomplete window * Add new ConVar to show help text next to ConVar in autocomplete. disabled by default to prevent it from being cluttered.
2022-01-19 19:00:40 +01:00
ImGuiWindowFlags_NoMove |
ImGuiWindowFlags_NoTitleBar |
ImGuiWindowFlags_NoSavedSettings |
ImGuiWindowFlags_NoFocusOnAppearing |
ImGuiWindowFlags_NoBringToFrontOnFocus |
ImGuiWindowFlags_AlwaysVerticalScrollbar |
ImGuiWindowFlags_AlwaysHorizontalScrollbar;
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
public:
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
bool m_bActivate = false;
Console performance improvements and bug fixes * Heavily reduced string compares for coloring logs (the left overs require a dedicated hook, this is for the future) The new method uses a ImVec 4 constant containing the color obtained via a switch case by context, this is then out into the new CConLog structure where the loop in the console will now gather the colors directly from. Error/Warning use a single constant. * Fixed bugs in several log locations where the ostringstream was cleared before the emission causing double logs. * Added global log mutex to log wrappers that lacked those.
2022-05-09 02:20:07 +02:00
vector<CConLog> m_ivConLog;
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
vector<CSuggest> m_vsvCommandBases;
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
Optimizations + QoL improvements/cleanup * IConsole overlay now clears the oldest log entries to stay under the vector limit instead of clearing the whole vector. * IConsole code cleanup. * IBrowser code cleanup, reordered class methods. * Use ConVar utilities to get/set values for strings in IBrowser and IConsole. * New ConVar's for RUI console overlay to tweak colors.
2022-01-12 02:53:07 +01:00
///////////////////////////////////////////////////////////////////////////
Update comment blocks
2022-02-14 02:31:42 +01:00
CConsole(void);
~CConsole(void);
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
bool Setup(void);
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
void Draw(const char* pszTitle, bool* bDraw);
void Think(void);
void BasePanel(bool* bDraw);
void OptionsPanel(void);
void SuggestPanel(void);
bool CanAutoComplete(void);
Cleanup CConsole
2022-03-25 13:31:31 +01:00
void ResetAutoComplete(void);
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
void FindFromPartial(void);
void ProcessCommand(const char* pszCommand);
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
int ColorCodeFlags(int nFlags) const;
Optimizations + QoL improvements/cleanup * IConsole overlay now clears the oldest log entries to stay under the vector limit instead of clearing the whole vector. * IConsole code cleanup. * IBrowser code cleanup, reordered class methods. * Use ConVar utilities to get/set values for strings in IBrowser and IConsole. * New ConVar's for RUI console overlay to tweak colors.
2022-01-12 02:53:07 +01:00
See description * Add ConVar to allow user to set/unset FCVAR_DEVELOPMENTONLY ConVar's (default behavior would never be hit without this ConVar). * Add icons to display the flags of a certain CommandBase. * Fixed Dear ImGui not displaying images correctly (descriptor needs DXGI_FORMAT_R8G8B8A8_UNORM_SRGB due to the nature of this game). * Dynamically obtain buffer sizes of resources taken from modules. * Light SDK cleanup.
2022-04-26 20:24:51 +02:00
int TextEditCallback(ImGuiInputTextCallbackData* pData);
static int TextEditCallbackStub(ImGuiInputTextCallbackData* pData);
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
///////////////////////////////////////////////////////////////////////////
Finish game console optimizations The console no longer should cause huge frame drops when the vector size increases around its max size
2022-05-10 13:26:03 +02:00
void AddLog(ImVec4 color, const char* fmt, ...) IM_FMTARGS(2);
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
void ClearLog(void);
Update comment blocks
2022-02-14 02:31:42 +01:00
void ColorLog(void) const;
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
///////////////////////////////////////////////////////////////////////////
Implement autocomplete logic for in-game console. Autocompletes based on user input. Also shows ConVar's current value.
2022-01-17 23:20:03 +01:00
void SetStyleVar(void);
Split CCompanion and CGameConsole into separate implementations
2021-08-06 18:12:07 -07:00
};
Optimizations + QoL improvements/cleanup * IConsole overlay now clears the oldest log entries to stay under the vector limit instead of clearing the whole vector. * IConsole code cleanup. * IBrowser code cleanup, reordered class methods. * Use ConVar utilities to get/set values for strings in IBrowser and IConsole. * New ConVar's for RUI console overlay to tweak colors.
2022-01-12 02:53:07 +01:00
///////////////////////////////////////////////////////////////////////////////
extern CConsole* g_pIConsole;
Code base refactor + major performance and readability improvement. Read description for details. * Codebase restructured to SourceSDK codebase style and .cpp/.h assertion paths in the game executable. * Document most functions with valve style 'Purpose' blocks. * Rename variables to match the rest of the codebase and Valve's naming convention. * Dedicated DLL and the SDKLauncher now share the same codebase as the DevSDK. * Obtain globals or pointers directly instead of waiting for runtime initialized data. * Dynamically search for all functions and globals (this doesn't count for dedicated yet!). * Initialize most in-SDK variables. * Move certain prints and other utilities under ConVars to reduce verbosity and increase performance. * Print all pattern scan results through a virtual function to make it easier to add and debug new patterns in the future. * Type global var pointers appropriately if class or type is known and implemented. * Forward declare 'CClient' class to avoid having 2 'g_pClient' copies. * Add IDA's pseudo definitions for easier prototyping with decompiled assembly code. * RPAK decompress Command callback implementation. * Load decompressed RPaks from 'paks\Win32\' overriding the ones in 'paks\Win64\' (the decompress callback will automatically fix the header and write it to 'paks\Win32\'). * VPK decompress Command callback implementation. * Move CRC32 ands Adler32 to implementation files. * Server will print out more details about the connecting client. * Upgrade ImGui lib to v1.86. * Don't compile id3dx.h for dedicated. * Don't compile id3dx.cpp for dedicated * Implement DevMsg print function allowing to print information to the in-game VGUI/RUI console overlay, ImGui console overlay and the external windows console * Fixed bug where the Error function would not properly terminate the process when an error is called. This caused access violations for critical/non-recoverable errors. * Fixed bug where the game would crash if the console or server browser was enabled while the game was still starting up. * Several bug fixes for the dedicated server (warning: dedicated is still considered work-in-progress!).
2021-12-25 22:36:38 +01:00
#endif // !DEDICATED
Reference in New Issue Copy Permalink