1. Epic GamesDeveloper
  3. FConsoleVariablesEditorCommandInfo

FConsoleVariablesEditorCommandInfo

API > API/Plugins > API/Plugins/ConsoleVariablesEditor

References

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

Syntax

struct FConsoleVariablesEditorCommandInfo

Variables

  Type Name Description
Public variable bool bSetInCurrentSession If the variable was last changed by the current preset
Public variable UProperty FString Command The actual string key or name
Public variable IConsoleObject * ConsoleObjectPtr This object is periodically refreshed to mitigate the occurrence of stale pointers.
Public variable double ConsoleObjectRefreshThreshold  
Public variable EConsoleObjectType ObjectType  
Public variable FOnDetectConsoleObjectUnregistered OnDetectConsoleObjectUnregistered When commands are unregistered change, this callback is broadcasted.
Public variable FDelegateHandle OnDetectConsoleObjectUnregisteredHandle  
Public variable FDelegateHandle OnVariableChangedCallbackHandle When variables change, this callback is executed.
Public variable EConsoleVariableFlags StartupSource The source of this variable's (if Variable object type) last setting as recorded when the plugin was loaded.
Public variable FString StartupValueAsString 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.
Public variable FDateTime TimeOfLastConsoleObjectRefresh  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Static FText

ConvertConsoleVariableSetByFlagToText ( const EConsoleVariableFlags InFlag
)

  
Public function 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.
Public function IConsoleCommand * Return the console object as a console command object if applicable.
Public function IConsoleObject * Get a reference to the cached console object. May return nullptr if unregistered.
Public function IConsoleVariable * Return the console object as a console variable object if applicable.
Public function bool

GetCurrentValueAsString ( FString& OutValueAsString
)

 If this console object is a variable, get its value as string via OutValueAsString.
Public function Static UWorld *  
Public function FString  
Public function EConsoleVariableFlags  
Public function FText  
Public function bool

IsCurrentValueDifferentFromInputValue ( const FString& InValueToCompare
)

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

SetIfChangedInCurrentPreset ( const bool bNewSetting
)

  
Public function void

SetSourceFlag ( const EConsoleVariableFlags InSource
)

  

Operators

  Type Name Description
Public function Const bool  

Classes

  Type Name Description
Public struct FStaticConsoleVariableFlagInfo    

Enums

  Type Name Description
Public enum EConsoleObjectType    

Constants

Name Description
SupportedFlags A mapping of SetBy console variable flags to information like the associated display text.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page