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

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

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

Syntax

UCLASS (MinimalAPI, Config=CommonUI, defaultconfig, ClassGroup=UI,  
       Meta=(Category="Common UI", DisplayName="Common Text", prioritizeCategories="Content"))  
class UCommonTextBlock : public UTextBlock

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonTextBlock ( const FObjectInitializer& ObjectInitializer
)

   CommonTextBlock.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAutoCollapseWithEmptyText bool True to automatically collapse this text block when set to display an empty string. CommonTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=CommonText
  • Meta=(AllowPrivateAccess=true)
bIsScrollingEnabled bool If scrolling is enabled/disabled initially, this can be updated in blueprint CommonTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=CommonText
  • Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)
bStyleNoLongerNeedsConversion bool Used to track widgets that were created before changing the default style pointer to null CommonTextBlock.h  
ScrollOrientation TEnumAsByte< EOrientation > The orientation the text will scroll if out of bounds. CommonTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=CommonText
  • Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)
ScrollStyle TSubclassOf< UCommonTextScrollStyle > References the scroll style asset to use, no reference disables scrolling CommonTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=CommonText
  • Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)
Style TSubclassOf< UCommonTextStyle > References the text style to use CommonTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=CommonText
  • Meta=(ExposeOnSpawn=true, AllowPrivateAccess=true)
TextScroller TSharedPtr< class STextScroller >   CommonTextBlock.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FMargin & GetMargin()

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

float GetMobileFontSizeMultiplier()

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text|Mobile"

void ResetScrollState()

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text|Scroll Style"

void SetApplyLineHeightToBottomLine ( bool InApplyLineHeightToBottomLine
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

void SetLineHeightPercentage ( float InLineHeightPercentage
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

void SetMargin ( const FMargin& InMargin
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

void SetMobileFontSizeMultiplier ( float InMobileFontSizeMultiplier
)

 Sets the new value and then applies the FontSizeMultiplier CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text|Mobile"

void SetScrollingEnabled ( bool bInIsScrollingEnabled
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text|Scroll Style"

void SetScrollOrientation ( TEnumAsByte< EOrientation > InScrollOrientation
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

void SetStyle ( TSubclassOf< UCommonTextStyle > InStyle
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

void SetTextCase ( bool bUseAllCaps
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

void SetWrapTextWidth ( int32 InWrapTextAt
)

   CommonTextBlock.h
  • BlueprintCallable
  • Category="Common Text"

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   CommonTextBlock.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   CommonTextBlock.h  

virtual void PostLoad()

   CommonTextBlock.h  

virtual void Serialize ( FArchive& Ar
)

   CommonTextBlock.h  

Protected

Overridden from UTextBlock

Name Remarks Include Path Unreal Specifiers

virtual void OnFontChanged()

   CommonTextBlock.h  

virtual void OnTextChanged()

   CommonTextBlock.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   CommonTextBlock.h  

virtual void OnCreationFromPalette()

   CommonTextBlock.h  

virtual TSharedRef< SWidget > RebuildWidget()

   CommonTextBlock.h  

virtual void SynchronizeProperties()

   CommonTextBlock.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   CommonTextBlock.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page