1. Epic GamesDeveloper
  3. UCommonUISettings

UCommonUISettings

API > API/Plugins > API/Plugins/CommonUI

   
Name UCommonUISettings
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonUISettings.h
Include Path #include "CommonUISettings.h"

Syntax

UCLASS (MinimalAPI, Config=Game, defaultconfig)  
class UCommonUISettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonUISettings ( const FObjectInitializer& Initializer
)

   CommonUISettings.h  
  CommonUISettings.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UCommonUISettings()

   CommonUISettings.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAutoLoadData bool Controls if the data referenced is automatically loaded. CommonUISettings.h
  • Config
  • EditAnywhere
  • Category="Default"
bDefaultDataLoaded bool   CommonUISettings.h  
CommonButtonAcceptKeyHandling ECommonButtonAcceptKeyHandling How should CommonButton widgets handle SlateNavigation Accept actions? CommonUISettings.h
  • Config
  • EditAnywhere
  • Category="Button"
DefaultImageResourceObject TSoftObjectPtr< UObject > The Default Image Resource, newly created CommonImage Widgets will use this style. CommonUISettings.h
  • Config
  • EditAnywhere
  • Category="Image"
  • Meta=(AllowedClasses="/Script/Engine.Texture2D,/Script/Engine.MaterialInterface")
DefaultImageResourceObjectInstance TObjectPtr< UObject >   CommonUISettings.h
  • Transient
DefaultRichTextDataClass TSoftClassPtr< UCommonUIRichTextData > The Default Data for rich text to show inline icon and others. CommonUISettings.h
  • Config
  • EditAnywhere
  • Category="RichText"
  • Meta=(AllowAbstract=false)
DefaultThrobberBrush FSlateBrush   CommonUISettings.h
  • Transient
DefaultThrobberMaterial TSoftObjectPtr< UMaterialInterface > The Default Throbber Material, newly created CommonLoadGuard Widget will use this style. CommonUISettings.h
  • Config
  • EditAnywhere
  • Category="Throbber"
DefaultThrobberMaterialInstance TObjectPtr< UMaterialInterface >   CommonUISettings.h
  • Transient
PlatformTraitContainer FGameplayTagContainer Merged version of PlatformTraits This is not the config property because there is no direct ini inheritance for structs (even ones like tag containers that represent a set), unlike arrays CommonUISettings.h  
PlatformTraits TArray< FGameplayTag > The set of traits defined per-platform (e.g., the default input mode, whether or not you can exit the application, etc...) CommonUISettings.h
  • Config
  • EditAnywhere
  • Category="Visibility"
  • Meta=(Categories="Platform.Trait", ConfigHierarchyEditable)
RichTextDataInstance TObjectPtr< UCommonUIRichTextData >   CommonUISettings.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AutoLoadData()

 Called by the module startup to auto load CommonUISetting data if bAutoLoadData is true. CommonUISettings.h  

ECommonButtonAcceptKeyHandling GetCommonButtonAcceptKeyHandling()

   CommonUISettings.h  

UObject * GetDefaultImageResourceObject()

   CommonUISettings.h  

const FSlateBrush & GetDefaultThrobberBrush()

   CommonUISettings.h  

const FGameplayTagContainer & GetPlatformTraits()

   CommonUISettings.h  

UCommonUIRichTextData * GetRichTextData()

   CommonUISettings.h  

void LoadData()

 Called to load CommonUISetting data, if bAutoLoadData if set to false then game code must call LoadData(). CommonUISettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CommonUISettings.h  

virtual void PostInitProperties()

   CommonUISettings.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

   CommonUISettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page