UDataprepContentConsumer

Abstract class providing the minimal services required for a DataprepConsumer

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDataprepContentConsumer

References

Module

DataprepCore

Header

/Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepContentConsumer.h

Include

#include "DataprepContentConsumer.h"

Syntax

UCLASS(Abstract, Config=EditorSettings, BlueprintType)
class UDataprepContentConsumer : public UObject

Remarks

Abstract class providing the minimal services required for a DataprepConsumer

Use the SDataprepConsumerWidget class to detail the properties of this class

Variables

Name Description

Protected variable

FDataprepConsum...

 

Context

Context which the consumer will run with

Protected variable UProperty

FString

 

LevelName

Protected variable

FDataprepConsum...

 

OnChanged

Delegate to broadcast changes to the consumer

Protected variable UProperty

FString

 

TargetContentFolder

Constructors

Name Description

Public function

UDataprepContentConsumer()

Functions

Name Description

Public function

bool

 

Consume

(
    const FDataprepConsumerContext& In...
)

Successively calls Initialize, Run and Reset.

Public function Virtual Const

const FText ...

 

GetDescription()

Text briefly describing what the consumer is doing with the world and assets it consumes.

Public function Virtual Const

const FText ...

 

GetLabel()

Name used by the UI to be displayed.

Public function UFunction BlueprintCallable, Category

const FStrin...

 

GetLevelName()

Public function

UDataprepCon...

 

GetOnChanged()

Public function UFunction BlueprintCallable, Category

const FStrin...

 

GetTargetContentFolder()

Public function Const

FString

 

GetTargetPackagePath()

Returns a well-formed path to use when calling CreatePackage to create the target package.

Protected function Virtual

bool

 

Initialize()

Initialize the consumer to be ready for the next call to the Run method.

Protected function

void

 

LogError

(
    const FText& Message
)

Protected function

void

 

LogInfo

(
    const FText& Message
)

Start of helper functions to log messages and report progress.

Protected function

void

 

LogWarning

(
    const FText& Message
)

Protected function Virtual

void

 

Reset()

Clean up the objects used by the consumer.

Protected function Virtual

bool

 

Run()

Requests the consumer to perform its operation.

Public function UFunction BlueprintCallable, Category

bool

 

SetLevelName

(
    const FString& InLevelName,
    FText& OutFailureReason
)

Sets the name of the level the consumer should move objects to if applicable.

Public function UFunction BlueprintCallable, Category

bool

 

SetLevelNameAutomated

(
    const FString& InLevelName,
    FText& OutFailureReason
)

Sets the name of the level the consumer should move objects to if applicable.

Protected function Virtual

bool

 

SetLevelNameImplementation

(
    const FString& InLevelName,
    FText& OutFailureReason,
    const bool bIsAutomated
)

Sets the name of the level the consumer should move objects to if applicable.

Public function UFunction BlueprintCallable, Category

bool

 

SetTargetContentFolder

(
    const FString& InTargetContentFold...,
    FText& OutFailureReason
)

Sets the path of the package the consumer should move assets to if applicable.

Public function UFunction BlueprintCallable, Category

bool

 

SetTargetContentFolderAutomated

(
    const FString& InTargetContentFold...,
    FText& OutFailureReason
)

Sets the path of the package the consumer should move assets to if applicable.

Protected function Virtual

bool

 

SetTargetContentFolderImplementation

(
    const FString& InTargetContentFold...,
    FText& OutFailureReason,
    const bool bIsAutomated
)

Sets the path of the package the consumer should move assets to if applicable.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Classes

Name

Description

Public class

FDataprepConsumerChanged

Allow an observer to be notified when one of the properties of the consumer changes

Constants

Name

Description

RelativeOutput

Name of marker to be used by consumers to indicate specific output for assets or actors