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

Inheritance Hierarchy

References

   
Module ConsoleVariablesEditorRuntime
Header /Engine/Plugins/Editor/ConsoleVariablesEditor/Source/ConsoleVariablesEditorRuntime/Public/ConsoleVariablesAsset.h
Include #include "ConsoleVariablesAsset.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UConsoleVariablesAsset :  
    public UObject,  
    public IMovieSceneConsoleVariableTrackInterface

Remarks

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

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void 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.
Public function UFunction BlueprintCallable, Category void

CopyFrom ( const UConsoleVariablesAsset* InAssetToCopy
)

 Copy data from input asset to this asset
Public function Const UFunction BlueprintCallable, Category, Meta void

ExecuteSavedCommands ( UObject* WorldContextObject,
bool bOnlyIncludeChecked
)

 Executes all saved commands in this asset, optionally only including those with a Checked checkstate in the UI.
Public function Const UFunction BlueprintCallable, Category bool

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

 Outputs the FConsoleVariablesEditorAssetSaveData matching InCommand.
Public function Const UFunction BlueprintPure, Category const TArray< FConsoleVariablesEditorAssetSaveData > & 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.
Public function Const UFunction BlueprintPure, Category FString

GetSavedCommandsAsCommaSeparatedString ( bool bOnlyIncludeChecked
)

 Returns the saved list of console variables as a concatenated comma-separated string.
Public function Const UFunction BlueprintPure, Category TArray< FString >

GetSavedCommandsAsStringArray ( bool bOnlyIncludeChecked
)

 Returns the saved list of console variables as an array of FString.
Public function Const UFunction BlueprintPure, Category int32 Returns how many console variables are serialized in this asset
Public function Const UFunction BlueprintPure, Category FString  
Public function UFunction BlueprintCallable, Category bool

RemoveConsoleVariable ( const FString InCommandString
)

 Returns true if the element was found and successfully removed.
Public function UFunction BlueprintCallable, Category void Completely replaces the saved data with new saved data
Public function UFunction BlueprintCallable, Category void

SetVariableCollectionDescription ( const FString& InVariableCollectionDescription
)

 Sets a description for this variable collection.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page