Navigation
API > API/Runtime > API/Runtime/Engine
| Name | ADocumentationActor |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/DocumentationActor.h |
| Include Path | #include "Engine/DocumentationActor.h" |
Syntax
UCLASS (
HideCategories=(Sprite, MaterialSprite, Actor, Transform, Tags, Materials, Rendering, Components, Blueprint, bject, Collision, Display, Rendering, Physics, Input, Lighting, Layers),
MinimalAPI)
class ADocumentationActor : public AActor
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ADocumentationActor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ADocumentationActor
(
const FObjectInitializer& ObjectInitializer |
Engine/DocumentationActor.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DocumentLink | FString | Link to a help document. | Engine/DocumentationActor.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Billboard | TObjectPtr< class UMaterialBillboardComponent > | Engine/DocumentationActor.h |
|
|
| LinkType | EDocumentationActorType::Type | Engine/DocumentationActor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMaterialBillboardComponent * GetBillboard() |
Returns Billboard subobject | Engine/DocumentationActor.h | |
EDocumentationActorType::Type GetLinkType() |
Determine the type of link contained in the DocumentLink member | Engine/DocumentationActor.h | |
bool HasValidDocumentLink() |
Is the document link this actor has valid | Engine/DocumentationActor.h | |
bool OpenDocumentLink() |
Open the document link this actor relates to | Engine/DocumentationActor.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Engine/DocumentationActor.h | ||
virtual void PostLoad() |
Engine/DocumentationActor.h |