FTokenizedMessage

This class represents a rich tokenized message, such as would be used for compiler output with 'hyperlinks' to source file locations

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FTokenizedMessage

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Logging/TokenizedMessage.h

Include

#include "Logging/TokenizedMessage.h"

Syntax

class FTokenizedMessage : public TSharedFromThis< FTokenizedMessage >

Remarks

This class represents a rich tokenized message, such as would be used for compiler output with 'hyperlinks' to source file locations

Variables

Name Description

Protected variable

TSharedPtr< IMe...

 

MessageLink

A token associated with the entire message (doesn't display)

Protected variable

TArray< TShared...

 

MessageTokens

The array of message tokens this message contains

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function

TSharedRef< ...

 

AddToken

(
    const TSharedRef< IMessageToken >&...
)

Adds a token to a message.

Public function Static

TSharedRef< ...

 

Create

(
    EMessageSeverity::Type InSeverity,
    const FText& InMessageText
)

Creates a new FTokenizedMessage

Public function Const

FName

 

GetIdentifier()

Public function Const

TSharedPtr< ...

 

GetMessageLink()

Gets the token action associated with this messages as a whole.

Public function Const

const TArray...

 

GetMessageTokens()

Get the tokens in this message

Public function Const

EMessageSeve...

 

GetSeverity()

Gets the severity of this message

Public function Static

FName

 

GetSeverityIconName

(
    EMessageSeverity::Type InSeverity
)

Helper function for getting a severity as an icon name

Public function Static

FText

 

GetSeverityText

(
    EMessageSeverity::Type InSeverity
)

Helper function for getting a severity as text

Public function

void

 

SetIdentifier

(
    FName InIdentifier
)

Assigns Identifier for the message to the provided name

Public function

void

 

SetMessageLink

(
    const TSharedRef< IMessageToken >&...
)

Sets up a token action for the message as a whole (not to be displayed... intended to be invoked from a double click).

Public function

void

 

SetSeverity

(
    const EMessageSeverity::Type InSeve...
)

Sets the severity of this message

Public function Const

FText

 

ToText()

Get this tokenized message as a string