1. Epic GamesDeveloper
  3. FAvaFont

FAvaFont

API > API/Plugins > API/Plugins/AvalancheText > API/Plugins/AvalancheText/Font

References

   
Module AvalancheText
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheText/Public/Font/AvaFont.h
Include #include "Font/AvaFont.h"

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="Motion Design Font"))  
struct FAvaFont

Constructors

  Type Name Description
Public function   Default constructor: calling GetFont() right after the constructor will return the default font
Public function  

FAvaFont ( UAvaFontObject* InFontObject
)

 This FAvaFont will be initialized using the provided UAvaFontObject

Functions

  Type Name Description
Public function Static bool

AreSameFont ( const FAvaFont* InFontA,
const FAvaFont* InFontB
)

 Checks if the specified Ava Fonts are the same
Public function void Calling this function will null the now deprecated UFont CurrentFont reference, and use that UFont to initialize the currently used UAvaFontObject
Public function Static FString

GenerateFontFormattedString ( const FString& InFontName,
const FString& InFontObjectPathName
)

 Returns a formatted string representing a FAvaFont for the specified FontObjectPathName and FontName Useful e.g. when setting the value of multiple FAvaFonts using IPropertyHandle->SetPerObjectValues
Public function Static bool

GenerateFontFormattedString ( const UAvaFontObject* InFontObject,
FString& OutFormattedString
)

 Returns a formatted string representing a FAvaFont for the specified UAvaFontObject Useful e.g. when setting the value of multiple FAvaFonts using IPropertyHandle->SetPerObjectValues
Public function Static UFont * Returns a default font (Roboto).
Public function UFont *

GetFont ()

 Returns the currently stored font, or default font if none available.
Public function Const FName Returns current font name, as FName
Public function Const FString Returns current font name as FString
Public function Const UAvaFontObject * Returns the currently stored UAvaFontObject.
Public function Const EAvaFontSource Returns current font source (System, Project or Invalid)
Public function Const const FString & In case this FAvaFont is in fallback state, this call can return the name of the missing font asset, if available.
Public function Const bool Checks if the currently referenced font asset is valid.
Public function Const bool

IsBold ()

 Returns true if font is bold
Public function Const bool Checks if this FAvaFont is referencing the default font.
Public function Const bool Checks if this FAvaFont is in fallback state.
Public function Const bool Returns true if this FAvaFont is marked as favorite by the user
Public function Const bool Returns true if font is italic
Public function Const bool Returns true if font is monospaced
Public function void

PostSerialize ( const FArchive& Ar
)

 Called after serialization of FAvaFont.
Public function void

SetFavorite ( const bool bFavorite
)

 Mark/unmark this font as favorite
Public function void

SetFontObject ( UAvaFontObject* InFontObject
)

 Directly sets the current UAvaFontObject, and then updates this FAvaFont accordingly.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FAvaFont& Other
)

  
Public function Const bool

operator== ( const FAvaFont& Other
)

 Fonts are considered equal if they share the same font and font name

Enums

  Type Name Description
Private enum EFontAssetState Used to handle font state and possible loading issues  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page