1. Epic GamesDeveloper
  3. UConsoleVariablesEditorFunctionLibrary

UConsoleVariablesEditorFunctionLibrary

An asset used to track collections of console variables that can be recalled and edited using the Console Variables Editor.

API > API/Plugins > API/Plugins/ConsoleVariablesEditor

An asset used to track collections of console variables that can be recalled and edited using the Console Variables Editor.

   
Name UConsoleVariablesEditorFunctionLibrary
Type class
Header File /Engine/Plugins/Editor/ConsoleVariablesEditor/Source/ConsoleVariablesEditor/Public/ConsoleVariablesEditorFunctionLibrary.h
Include Path #include "ConsoleVariablesEditorFunctionLibrary.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UConsoleVariablesEditorFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddValidatedCommandToCurrentPreset ( const FString NewCommand
)

 Adds a validated command to the current preset with its current value. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool CopyCurrentListToAsset ( UConsoleVariablesAsset* InAsset
)

 Saves the current list in the Console Variables Editor to the given asset. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool GetConsoleVariableSourceByName ( const FString InCommandName,
FString& OutValue
)

 Set a console variable value directly. Returns true if the console object exists. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool GetConsoleVariableStringValue ( const FString InCommandName,
FString& OutValue
)

 Get a console variable's string value directly. Returns true if the console object exists. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static UConsoleVariablesAsset * GetCurrentlyLoadedPreset()

 Return the currently loaded list of variables in the Console Variables Editor. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool GetEnableMultiUserCVarSync()

 Return whether the Multi-user sync setting for the current instance of the editor is enabled. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool GetListOfCommandsFromPreset ( const UConsoleVariablesAsset* InAsset,
TArray< FString >& OutCommandList
)

 Return an array of strings containing the command names for each command found in the given preset. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static void LoadPresetIntoConsoleVariablesEditor ( const UConsoleVariablesAsset* InAsset,
const EConsoleVariablesEditorPresetImportMode InImportMode
)

 Loads the given asset in the Console Variables Editor and sets all its variable values. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool RemoveCommandFromCurrentPreset ( const FString NewCommand
)

 Removes a command from the current preset if it exists in the saved data. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

static bool SetConsoleVariableByName_Bool ( const FString InCommandName,
const bool InValue
)

 Set a console variable value directly. Returns true if the console object exists. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"
  • Meta=(DisplayName="Set Console Variable By Name (Bool)")

static bool SetConsoleVariableByName_Float ( const FString InCommandName,
const float InValue
)

 Set a console variable value directly. Returns true if the console object exists. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"
  • Meta=(DisplayName="Set Console Variable By Name (Float)")

static bool SetConsoleVariableByName_Int ( const FString InCommandName,
const int32 InValue
)

 Set a console variable value directly. Returns true if the console object exists. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"
  • Meta=(DisplayName="Set Console Variable By Name (Int)")

static bool SetConsoleVariableByName_String ( const FString InCommandName,
const FString InValue
)

 Set a console variable value directly. Returns true if the console object exists. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"
  • Meta=(DisplayName="Set Console Variable By Name (String)")

static void SetEnableMultiUserCVarSync ( bool bNewSetting
)

 Enable or disable the Multi-user sync setting for the current instance of the editor. ConsoleVariablesEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Console Variables Editor"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page