PROTO Animated Text

This page lists the parameters, functions, and events available to users of the plugin.

ProtoRichTextBlock

Child class of Epic’s default RichTextBlock.

The text widget that can contain animated rich text.

Notable Parameters

Proto Text Style Set

A Data Table containing text style settings for this rich text, with extra parameters for ProtoRichTextBlock.

  • Setting this parameter is required for text to print correctly.
  • Data Table must use the ProtoRichTextStyleRow struct.
  • Use this parameter, NOT TextStyleSet
    • Widget Set

    A Data Table containing widget style settings for this rich text.

  • Setting this parameter is required for inserting widgets into text.
  • Data Table must use the ProtoRichWidgetRow struct.
    • Image Set

    A Data Table containing image style settings for this rich text.

  • Setting this parameter is required for inserting images into text.
  • Data Table must use the ProtoRichImageRow struct.
    • Override Print Letter Interval

    If true, override the PrintLetterInterval from the Proto Text Style with one specified below (Print Letter Interval).

    Print Letter Interval

    How many seconds to wait between letters when printing letter-by-letter.

  • Only used when Override Print Letter Interval is true.
    • Override Print Letter Animation Time

    If true, override the PrintLetterAnimationTime from the Proto Text Style with one specified below (Print Letter Animation Time)

    Print Letter Animation Time

    How many seconds the letter print animation takes when printing letter-by-letter.

  • Only used when Override Print Letter Animation Time is true.
  • this only affects the data sent to font materials, so this only has an effect if using the CharPrintPercent value from the ProtoRichText_Data node.

    • Blueprint Functions

    PrintLetterByLetter

    Play a letter-by-letter animation revealing the current text in this widget.

    IsLetterByLetterPrintInProgress

    Returns true if this text box is currently printing letter-by-letter.

    HideText

    Sets text alpha to 0.0.

  • Will stop a letter-by-letter print.
  • Runs of text with the markup <text donthide=””>...</> will stay visible when HideText is called. Same with images and widgets.
    • ShowText

    Sets text alpha to 1.0.

  • Will stop a letter-by-letter print.
    • SetPrintLetterIntervalOverride

    Helper function to override PrintLetterInterval. Call ClearPrintLetterIntervalOverride to clear.

    ClearPrintLetterIntervalOverride

    Clear override to PrintLetterInterval set by OverridePrintLetterInterval.

    Blueprint Events

    OnBeginLetterByLetterPrint

    Called when this text begins printing letter-by-letter.

    OnPrintLetter

    Called each time a character is printed in a letter-by-letter print.

    OnFinishLetterByLetterPrint

    Called when this text finishes printing letter-by-letter.

    OnPauseLetterByLetterPrint

    Called when the letter-by-letter print pauses for a long-interval character.

  • Depends on settings in your FProtoRichTextStyle.
  • E.G. commas, ends of sentences.
    • OnResumeLetterByLetterPrint

    Called when the letter-by-letter print resumes after pausing for a long-interval character.

  • Depends on settings in your FProtoRichTextStyle.
  • E.G. commas, ends of sentences.
    • OnNewBlockLetterByLetterPrint

    Called when the letter-by-letter print reaches the first character of a new text block.

    Provides the name of the Text Style for this block.

    OnWidgetClicked

    Called when an in-line Widget is clicked.

  • Widget must be a child of ProtoRichTextUserWidget and call CallOnClicked.
    • OnWidgetPressed

    Called when an in-line Widget is pressed.

  • Widget must be a child of ProtoRichTextUserWidget and call CallOnPressed.
    • OnWidgetReleased

    Called when an in-line Widget is released.

  • Widget must be a child of ProtoRichTextUserWidget and call CallOnReleased.
    • OnWidgetHovered

    Called when an in-line Widget is hovered.

  • Widget must be a child of ProtoRichTextUserWidget and call CallOnHovered.
    • OnWidgetUnhovered

    Called when an in-line Widget is un-hovered.

  • Widget must be a child of ProtoRichTextUserWidget and call CallOnUnhovered.

    • ProtoRichTextBlock

    Child class of UserWidget.

    Able to send events through a ProtoRichTextBlock when inserted in-line in text.

    Blueprint Functions

    CallOnClicked

    Call to broadcast an OnClick event to a ProtoRichTextBlock.

    CallOnPressed

    Call to broadcast an OnPressed event to a ProtoRichTextBlock.

    CallOnReleased

    Call to broadcast an OnReleased event to a ProtoRichTextBlock.

    CallOnHovered

    Call to broadcast an OnHovered event to a ProtoRichTextBlock.

    CallOnUnhovered

    Call to broadcast an OnUnhovered event to a ProtoRichTextBlock.