FDocumentationToken

Basic message token that defaults is activated method to access UDN documentation.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Core

Header

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

Include

#include "Logging/TokenizedMessage.h"

Syntax

class FDocumentationToken : public IMessageToken

Remarks

Basic message token that defaults is activated method to access UDN documentation.

Constructors

Name Description

Protected function

FDocumentationToken

(
    FString InDocumentationLink,
    FString InPreviewExcerptLink,
    FString InPreviewExcerptName
)

Protected constructor

Functions

Name Description

Public function Static

TSharedRef< ...

 

Create

(
    const FString& InDocumentationLink,
    const FString& InPreviewExcerptLin...,
    const FString& InPreviewExcerptNam...
)

Factory method, tokens can only be constructed as shared refs

Public function Const

const FStrin...

 

GetDocumentationLink()

End IMessageToken interface Get the documentation link used by this token

Public function Const

const FStrin...

 

GetPreviewExcerptLink()

Get the documentation excerpt link used by this token

Public function Const

const FStrin...

 

GetPreviewExcerptName()

Get the documentation excerpt name used by this token

Overridden from IMessageToken

Name Description

Public function Virtual Const

EMessageToke...

 

GetType()

Begin IMessageToken interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss