1. Epic GamesDeveloper
  3. UConsoleVariablesAsset

UConsoleVariablesAsset

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/ConsoleVariablesEditorRuntime

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

   
Name UConsoleVariablesAsset
Type class
Header File /Engine/Plugins/Editor/ConsoleVariablesEditor/Source/ConsoleVariablesEditorRuntime/Public/ConsoleVariablesAsset.h
Include Path #include "ConsoleVariablesAsset.h"

Syntax

UCLASS (BlueprintType)  
class UConsoleVariablesAsset :  
    public UObject ,  
    public IMovieSceneConsoleVariableTrackInterface

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
SavedCommands TArray< FConsoleVariablesEditorAssetSaveData > A saved list of console variable information such as the variable name, the type and the value of the variable at the time the asset was saved. ConsoleVariablesAsset.h  
VariableCollectionDescription FString User defined description of the variable collection ConsoleVariablesAsset.h
  • AssetRegistrySearchable
  • BlueprintGetter="GetVariableCollectionDescription"
  • EditAnywhere
  • Category="Console Variables Editor"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddFrom ( const UConsoleVariablesAsset* InAssetToCopy
)

 Add list of variables from input asset to this asset's list ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"

void AddOrSetConsoleObjectSavedData ( const FConsoleVariablesEditorAssetSaveData& InData
)

 Set the value of a saved console variable if the name matches; add a new console variable to the list if a match is not found. ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"

void CopyFrom ( const UConsoleVariablesAsset* InAssetToCopy
)

 Copy list of variables from input asset to this asset ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"

void ExecuteSavedCommands ( UObject* WorldContextObject,
bool bOnlyIncludeChecked
) const

 Executes all saved commands in this asset, optionally only including those with a Checked checkstate in the UI. ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"
  • Meta=(WorldContext="WorldContextObject")

bool FindSavedDataByCommandString ( const FString& InCommandString,
FConsoleVariablesEditorAssetSaveData& OutValue,
const ESearchCase::Type SearchCase
) const

 Outputs the FConsoleVariablesEditorAssetSaveData matching InCommand. ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"

const TArray< FConsoleVariablesEditorAssetSaveData > & GetSavedCommands()

 Returns the saved list of console variable information such as the variable name, the type and the value of the variable at the time the asset was saved. ConsoleVariablesAsset.h
  • BlueprintPure
  • Category="Console Variables Asset"

FString GetSavedCommandsAsCommaSeparatedString ( bool bOnlyIncludeChecked
) const

 Returns the saved list of console variables as a concatenated comma-separated string. ConsoleVariablesAsset.h
  • BlueprintPure
  • Category="Console Variables Asset"

TArray< FString > GetSavedCommandsAsStringArray ( bool bOnlyIncludeChecked
) const

 Returns the saved list of console variables as an array of FString. ConsoleVariablesAsset.h
  • BlueprintPure
  • Category="Console Variables Asset"

int32 GetSavedCommandsCount()

 Returns how many console variables are serialized in this asset ConsoleVariablesAsset.h
  • BlueprintPure
  • Category="Console Variables Asset"

FString GetVariableCollectionDescription()

   ConsoleVariablesAsset.h
  • BlueprintPure
  • Category="Console Variables Editor"

bool RemoveConsoleVariable ( const FString& InCommandString
)

 Returns true if the element was found and successfully removed. ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"

void ReplaceSavedCommands ( const TArray< FConsoleVariablesEditorAssetSaveData >& Replacement
)

 Completely replaces the saved data with new saved data ConsoleVariablesAsset.h
  • BlueprintCallable
  • Category="Console Variables Asset"

void SetVariableCollectionDescription ( const FString& InVariableCollectionDescription
)

 Sets a description for this variable collection. ConsoleVariablesAsset.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