Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Logging
Inheritance Hierarchy
- FSharedFromThisBase
- 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
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedPtr< IMessageToken > | MessageLink | A token associated with the entire message (doesn't display) |
 |
TArray< TSharedRef< IMessageToken > > | MessageTokens | The array of message tokens this message contains |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FTokenizedMessage
(
FPrivateToken |
Private constructor - we want to only create these structures as shared references via Create() |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedRef< FTokenizedMessage > | Adds a text token to a message. | |
 |
TSharedRef< FTokenizedMessage > | AddText
(
FTextFormat InTextFormat, |
Adds a text token to a message as by calling FText::FormatOrdered |
 |
TSharedRef< FTokenizedMessage > | AddToken
(
const TSharedRef< IMessageToken >& InToken |
Adds a token to a message. |
  |
TSharedRef< FTokenizedMessage > | Clone () |
Clone this message. The message tokens are shared between the original and the clone. |
  |
TSharedRef< FTokenizedMessage > | Create
(
EMessageSeverity::Type InSeverity, |
Creates a new FTokenizedMessage |
  |
FName | ||
  |
TSharedPtr< IMessageToken > | Gets the token action associated with this messages as a whole. | |
  |
const TArray< TSharedRef< IMessageToken > > & | Get the tokens in this message | |
  |
EMessageSeverity::Type | GetSeverity () |
Gets the severity of this message |
  |
FName | GetSeverityIconName
(
EMessageSeverity::Type InSeverity |
Helper function for getting a severity as an icon name |
  |
FText | GetSeverityText
(
EMessageSeverity::Type InSeverity |
Helper function for getting a severity as text |
 |
void | SetIdentifier
(
FName InIdentifier |
Assigns Identifier for the message to the provided name |
 |
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). |
 |
void | SetSeverity
(
const EMessageSeverity::Type InSeverity |
Sets the severity of this message |
  |
FText | ToText () |
Get this tokenized message as a string |