Navigation
API > API/Runtime > API/Runtime/Core
This class represents a rich tokenized message, such as would be used for compiler output with 'hyperlinks' to source file locations
| Name | FTokenizedMessage |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Logging/TokenizedMessage.h |
| Include Path | #include "Logging/TokenizedMessage.h" |
Syntax
class FTokenizedMessage : public TSharedFromThis< FTokenizedMessage >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FTokenizedMessage
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTokenizedMessage
(
FPrivateToken |
Private constructor - we want to only create these structures as shared references via Create() | Logging/TokenizedMessage.h |
Structs
| Name | Remarks |
|---|---|
| FPrivateToken | The private token allows only members or friends to call MakeShared. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Identifier | FName | Identifier for the message | Logging/TokenizedMessage.h | |
| Severity | EMessageSeverity::Type | The severity of this message | Logging/TokenizedMessage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< FTokenizedMessage > AddText
(
const FText& InText |
Adds a text token to a message. | Logging/TokenizedMessage.h | |
TSharedRef< FTokenizedMessage > AddText
(
FTextFormat InTextFormat, |
Adds a text token to a message as by calling FText::FormatOrdered | Logging/TokenizedMessage.h | |
TSharedRef< FTokenizedMessage > AddToken
(
const TSharedRef< IMessageToken >& InToken |
Adds a token to a message. | Logging/TokenizedMessage.h | |
TSharedRef< FTokenizedMessage > Clone() |
Clone this message. The message tokens are shared between the original and the clone. | Logging/TokenizedMessage.h | |
FName GetIdentifier() |
Logging/TokenizedMessage.h | ||
| Gets the token action associated with this messages as a whole. | Logging/TokenizedMessage.h | ||
const TArray< TSharedRef< IMessageToken > > & GetMessageTokens() |
Get the tokens in this message | Logging/TokenizedMessage.h | |
EMessageSeverity::Type GetSeverity() |
Gets the severity of this message | Logging/TokenizedMessage.h | |
void SetIdentifier
(
FName InIdentifier |
Assigns Identifier for the message to the provided name | Logging/TokenizedMessage.h | |
void SetMessageLink
(
const TSharedRef< IMessageToken >& InToken |
Sets up a token action for the message as a whole (not to be displayed... intended to be invoked from a double click). | Logging/TokenizedMessage.h | |
void SetSeverity
(
const EMessageSeverity::Type InSeverity |
Sets the severity of this message | Logging/TokenizedMessage.h | |
FText ToText() |
Get this tokenized message as a string | Logging/TokenizedMessage.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FTokenizedMessage > Create
(
EMessageSeverity::Type InSeverity, |
Creates a new FTokenizedMessage | Logging/TokenizedMessage.h | |
static FName GetSeverityIconName
(
EMessageSeverity::Type InSeverity |
Helper function for getting a severity as an icon name | Logging/TokenizedMessage.h | |
static FText GetSeverityText
(
EMessageSeverity::Type InSeverity |
Helper function for getting a severity as text | Logging/TokenizedMessage.h |