1. Epic GamesDeveloper
  3. FConsoleVariablesEditorCommandInfo

FConsoleVariablesEditorCommandInfo

API > API/Plugins > API/Plugins/ConsoleVariablesEditor

   
Name FConsoleVariablesEditorCommandInfo
Type struct
Header File /Engine/Plugins/Editor/ConsoleVariablesEditor/Source/ConsoleVariablesEditor/Public/ConsoleVariablesEditorCommandInfo.h
Include Path #include "ConsoleVariablesEditorCommandInfo.h"

Syntax

struct FConsoleVariablesEditorCommandInfo

Constructors

Name Remarks Include Path Unreal Specifiers

FConsoleVariablesEditorCommandInfo ( const FString& InCommand
)

   ConsoleVariablesEditorCommandInfo.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FConsoleVariablesEditorCommandInfo()

   ConsoleVariablesEditorCommandInfo.h  

Structs

Name Remarks
FStaticConsoleVariableFlagInfo  

Enums

Public

Name Remarks
EConsoleObjectType  

Constants

Name Type Remarks Include Path
SupportedFlags const TArray< FStaticConsoleVariableFlagInfo > A mapping of SetBy console variable flags to information like the associated display text. ConsoleVariablesEditorCommandInfo.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bHasAttemptedFind bool   ConsoleVariablesEditorCommandInfo.h  
bSetInCurrentSession bool If the variable was last changed by the current preset ConsoleVariablesEditorCommandInfo.h  
Command FString The actual string key or name ConsoleVariablesEditorCommandInfo.h  
ConsoleObjectPtr IConsoleObject * This object is periodically refreshed to mitigate the occurrence of stale pointers. ConsoleVariablesEditorCommandInfo.h  
ObjectType EConsoleObjectType   ConsoleVariablesEditorCommandInfo.h  
OnVariableChangedCallbackHandle FDelegateHandle When variables change, this callback is executed. ConsoleVariablesEditorCommandInfo.h  
StartupSource EConsoleVariableFlags The source of this variable's (if Variable object type) last setting as recorded when the plugin was loaded. ConsoleVariablesEditorCommandInfo.h  
StartupValueAsString FString The value of this variable (if Variable object type) when the module started in this session after it may have been set by an ini file. ConsoleVariablesEditorCommandInfo.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearSourceFlags()

   ConsoleVariablesEditorCommandInfo.h  

void ExecuteCommand ( const FString& NewValueAsString,
const bool bShouldTransactInConcert,
const bool bSetInSession,
const bool bIsInteractiveChange
)

 Sets a variable to the specified value whilst maintaining its SetBy flag. ConsoleVariablesEditorCommandInfo.h  
Return the console object as a console command object if applicable. ConsoleVariablesEditorCommandInfo.h  

IConsoleObject * GetConsoleObjectPtr()

 Get a reference to the cached console object. May return nullptr if unregistered. ConsoleVariablesEditorCommandInfo.h  
Return the console object as a console variable object if applicable. ConsoleVariablesEditorCommandInfo.h  

bool GetCurrentValueAsString ( FString& OutValueAsString
)

 If this console object is a variable, get its value as string via OutValueAsString. ConsoleVariablesEditorCommandInfo.h  

FString GetHelpText()

   ConsoleVariablesEditorCommandInfo.h  

EConsoleVariableFlags GetSource()

   ConsoleVariablesEditorCommandInfo.h  

FText GetSourceAsText()

   ConsoleVariablesEditorCommandInfo.h  

bool IsCurrentValueDifferentFromInputValue ( const FString& InValueToCompare
)

   ConsoleVariablesEditorCommandInfo.h  

void OnConsoleVariableChanged ( IConsoleVariable* ChangedVariable
)

   ConsoleVariablesEditorCommandInfo.h  

void PrintCommandOrVariable()

 Prints the current value or state of the command, similar to the text generated in teh output log when entering a command manually. ConsoleVariablesEditorCommandInfo.h  

void SetIfChangedInCurrentPreset ( const bool bNewSetting
)

   ConsoleVariablesEditorCommandInfo.h  

void SetSourceFlag ( const EConsoleVariableFlags InSource
)

   ConsoleVariablesEditorCommandInfo.h  

Static

Name Remarks Include Path Unreal Specifiers

static FText ConvertConsoleVariableSetByFlagToText ( const EConsoleVariableFlags InFlag
)

   ConsoleVariablesEditorCommandInfo.h  

static UWorld * GetCurrentWorld()

   ConsoleVariablesEditorCommandInfo.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FConsoleVariablesEditorCommandInfo& Comparator
) const

   ConsoleVariablesEditorCommandInfo.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page