Navigation
API > API/Plugins > API/Plugins/DataprepCore
Abstract class providing the minimal services required for a DataprepConsumer
Use the SDataprepConsumerWidget class to detail the properties of this class
| Name | UDataprepContentConsumer |
| Type | class |
| Header File | /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepContentConsumer.h |
| Include Path | #include "DataprepContentConsumer.h" |
Syntax
UCLASS (Abstract, Config=EditorSettings, BlueprintType)
class UDataprepContentConsumer : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDataprepContentConsumer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDataprepContentConsumer() |
DataprepContentConsumer.h |
Classes
| Name | Remarks |
|---|---|
| FDataprepConsumerChanged | Allow an observer to be notified when one of the properties of the consumer changes |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RelativeOutput | const FString | Name of marker to be used by consumers to indicate specific output for assets or actors | DataprepContentConsumer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Consume
(
const FDataprepConsumerContext& InContext |
Successively calls Initialize, Run and Reset. | DataprepContentConsumer.h | |
virtual const FText & GetDescription () |
Text briefly describing what the consumer is doing with the world and assets it consumes. | DataprepContentConsumer.h | |
virtual const FText & GetLabel() |
Name used by the UI to be displayed. | DataprepContentConsumer.h | |
const FString & GetLevelName() |
DataprepContentConsumer.h |
|
|
UDataprepContentConsumer::FDataprepConsumerChanged TBaseMulticastDelegate_NoParams GetOnChanged() |
DataprepContentConsumer.h | ||
const FString & GetTargetContentFolder() |
DataprepContentConsumer.h |
|
|
FString GetTargetPackagePath() |
Returns a well-formed path to use when calling CreatePackage to create the target package. | DataprepContentConsumer.h | |
virtual void PostEditUndo() |
DataprepContentConsumer.h | ||
bool SetLevelName
(
const FString& InLevelName, |
Sets the name of the level the consumer should move objects to if applicable. | DataprepContentConsumer.h |
|
bool SetLevelNameAutomated
(
const FString& InLevelName, |
Sets the name of the level the consumer should move objects to if applicable. | DataprepContentConsumer.h |
|
bool SetTargetContentFolder
(
const FString& InTargetContentFolder, |
Sets the path of the package the consumer should move assets to if applicable. | DataprepContentConsumer.h |
|
bool SetTargetContentFolderAutomated
(
const FString& InTargetContentFolder, |
Sets the path of the package the consumer should move assets to if applicable. | DataprepContentConsumer.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Initialize() |
Initialize the consumer to be ready for the next call to the Run method. | DataprepContentConsumer.h | |
void LogError
(
const FText& Message |
DataprepContentConsumer.h | ||
void LogInfo
(
const FText& Message |
Start of helper functions to log messages and report progress. | DataprepContentConsumer.h | |
void LogWarning
(
const FText& Message |
DataprepContentConsumer.h | ||
virtual void Reset () |
Clean up the objects used by the consumer. | DataprepContentConsumer.h | |
virtual bool Run() |
Requests the consumer to perform its operation. | DataprepContentConsumer.h | |
virtual bool SetLevelNameImplementation
(
const FString& InLevelName, |
Sets the name of the level the consumer should move objects to if applicable. | DataprepContentConsumer.h | |
virtual bool SetTargetContentFolderImplementation
(
const FString& InTargetContentFolder, |
Sets the path of the package the consumer should move assets to if applicable. | DataprepContentConsumer.h |