Navigation
API > API/Plugins > API/Plugins/ConsoleVariablesEditor
| Name | FConsoleVariablesEditorModule |
| Type | class |
| Header File | /Engine/Plugins/Editor/ConsoleVariablesEditor/Source/ConsoleVariablesEditor/Public/ConsoleVariablesEditorModule.h |
| Include Path | #include "ConsoleVariablesEditorModule.h" |
Syntax
class FConsoleVariablesEditorModule :
public IModuleInterface ,
public FGCObject
Inheritance Hierarchy
- FGCObject → FConsoleVariablesEditorModule
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FScopeMultiUserReceiveCVar | Scoped based struct to track inbound cvars set by Multi-user. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ConsoleVariablesToolkitPanelTabId | const FName | ConsoleVariablesEditorModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CommandsReceivedFromMultiUser | TMap< FString, int32 > | A map of commands invoked by Multi-user. | ConsoleVariablesEditorModule.h | |
| ConsoleObjectsMainReference | TMap< FString, TSharedPtr< FConsoleVariablesEditorCommandInfo > > | All tracked variables and their default, startup, and current values | ConsoleVariablesEditorModule.h | |
| EditingGlobalSearchAsset | TObjectPtr< UConsoleVariablesAsset > | Transient preset that tracks variables that match the search criteria | ConsoleVariablesEditorModule.h | |
| EditingPresetAsset | TObjectPtr< UConsoleVariablesAsset > | Transient preset that's being edited so we don't affect the reference asset unless we save it | ConsoleVariablesEditorModule.h | |
| MainPanel | TSharedPtr< FConsoleVariablesEditorMainPanel > | Lives for as long as the module is loaded. | ConsoleVariablesEditorModule.h | |
| OnConsoleObjectUnregisteredHandle | FDelegateHandle | ConsoleVariablesEditorModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddConsoleObjectCommandInfoToMainReference
(
TSharedRef< FConsoleVariablesEditorCommandInfo > InCommandInfo |
ConsoleVariablesEditorModule.h | ||
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
ConsoleVariablesEditorModule.h | ||
TWeakPtr< FConsoleVariablesEditorCommandInfo > FindCommandInfoByName
(
const FString& NameToSearch, |
Find a tracked console variable by the command string with optional case sensitivity. | ConsoleVariablesEditorModule.h | |
TArray< TWeakPtr< FConsoleVariablesEditorCommandInfo > > FindCommandInfosMatchingTokens
(
const TArray< FString >& InTokens, |
Find all tracked console variables matching a specific search query with optional case sensitivity. | ConsoleVariablesEditorModule.h | |
TObjectPtr< UConsoleVariablesAsset > GetGlobalSearchAsset() |
ConsoleVariablesEditorModule.h | ||
TObjectPtr< UConsoleVariablesAsset > GetPresetAsset() |
ConsoleVariablesEditorModule.h | ||
virtual FString GetReferencerName() |
ConsoleVariablesEditorModule.h | ||
void OnConsoleVariableChanged
(
FConsoleVariablesEditorCommandInfo& CommandInfo, |
ConsoleVariablesEditorModule.h | ||
void OnRemoteCvarChanged
(
ERemoteCVarChangeType InChangeType, |
ConsoleVariablesEditorModule.h | ||
void OpenConsoleVariablesDialogWithAssetSelected
(
const FAssetData& InAssetData, |
ConsoleVariablesEditorModule.h | ||
void OpenConsoleVariablesDialogWithPreset
(
const TObjectPtr< UConsoleVariablesAsset > Preset |
ConsoleVariablesEditorModule.h | ||
bool PopulateGlobalSearchAssetWithVariablesMatchingTokens
(
const TArray< FString >& InTokens |
Fills Global Search Asset's Saved Commands with variables matching the specified query. | ConsoleVariablesEditorModule.h | |
void QueryAndBeginTrackingConsoleVariables() |
Find all console variables and cache their startup values | ConsoleVariablesEditorModule.h | |
void RebuildList
(
const FString InConsoleCommandToScrollTo, |
Regenerate the list items and refresh the list. Call when adding or removing variables. | ConsoleVariablesEditorModule.h | |
void RefreshList () |
Refresh filters and sorting. | ConsoleVariablesEditorModule.h | |
void SavePreset() |
ConsoleVariablesEditorModule.h | ||
void SavePresetAs() |
ConsoleVariablesEditorModule.h | ||
void SaveSpecificPreset
(
const TObjectPtr< UConsoleVariablesAsset > Preset |
ConsoleVariablesEditorModule.h | ||
void SaveSpecificPresetAs
(
const TObjectPtr< UConsoleVariablesAsset > Preset |
ConsoleVariablesEditorModule.h | ||
void SendMultiUserConsoleVariableChange
(
ERemoteCVarChangeType InChangeType, |
ConsoleVariablesEditorModule.h | ||
void UpdatePresetValuesForSave
(
TObjectPtr< UConsoleVariablesAsset > InAsset |
ConsoleVariablesEditorModule.h | ||
FReply ValidateConsoleInputAndAddToCurrentPreset
(
const FText& CommittedText |
ConsoleVariablesEditorModule.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PreUnloadCallback() |
ConsoleVariablesEditorModule.h | ||
virtual void ShutdownModule() |
ConsoleVariablesEditorModule.h | ||
virtual void StartupModule() |
ConsoleVariablesEditorModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FConsoleVariablesEditorModule & Get() |
ConsoleVariablesEditorModule.h | ||
static void OpenConsoleVariablesEditor() |
ConsoleVariablesEditorModule.h |