1. Epic GamesDeveloper
  3. UCommonTextBlock

UCommonTextBlock

Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonTextBlock.h
Include #include "CommonTextBlock.h"

Syntax

UCLASS&40;Config&61;CommonUI, defaultconfig, ClassGroup&61;UI,  
       Meta&61;&40;Category&61;"Common UI", DisplayName&61;"Common Text", prioritizeCategories&61;"Content"&41;&41;  
class UCommonTextBlock : public UTextBlock

Remarks

Text block with automatic scrolling for FX / large texts, also supports a larger set of default styling, & custom mobile scaling.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float MobileFontSizeMultiplier Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize

Constructors

  Type Name Description
Public function  

UCommonTextBlock ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category const FMargin &  
Public function Const UFunction BlueprintCallable, Category float  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetLineHeightPercentage ( float InLineHeightPercentage
)

  
Public function UFunction BlueprintCallable, Category void

SetMargin ( const FMargin& InMargin
)

  
Public function UFunction BlueprintCallable, Category void

SetMobileFontSizeMultiplier ( float InMobileFontSizeMultiplier
)

 Sets the new value and then applies the FontSizeMultiplier
Public function UFunction BlueprintCallable, Category void

SetScrollingEnabled ( bool bInIsScrollingEnabled
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetTextCase ( bool bUseAllCaps
)

  
Public function UFunction BlueprintCallable, Category void

SetWrapTextWidth ( int32 InWrapTextAt
)

  

Overridden from UTextBlock

  Type Name Description
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Protected function Virtual const FText Gets the palette category of the widget
Protected function Virtual void Called after constructing a new widget from the palette.
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Protected function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Protected function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page