Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DataprepCore > UDataprepContentConsumer

Light Theme

Dark Theme

UDataprepContentConsumer

Abstract class providing the minimal services required for a DataprepConsumer

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](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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
FDataprepConsum...	Context	Context which the consumer will run with
FString	LevelName
FDataprepConsum...	OnChanged	Delegate to broadcast changes to the consumer
FString	TargetContentFolder

Constructors

	Name	Description
	UDataprepContentConsumer()

Functions

	Name	Description
bool	Consume ( const FDataprepConsumerContext& In... )	Successively calls Initialize, Run and Reset.
const FText ...	GetDescription()	Text briefly describing what the consumer is doing with the world and assets it consumes.
const FText ...	GetLabel()	Name used by the UI to be displayed.
const FStrin...	GetLevelName()
UDataprepCon...	GetOnChanged()
const FStrin...	GetTargetContentFolder()
FString	GetTargetPackagePath()	Returns a well-formed path to use when calling CreatePackage to create the target package.
bool	Initialize()	Initialize the consumer to be ready for the next call to the Run method.
void	LogError ( const FText& Message )
void	LogInfo ( const FText& Message )	Start of helper functions to log messages and report progress.
void	LogWarning ( const FText& Message )
void	Reset()	Clean up the objects used by the consumer.
bool	Run()	Requests the consumer to perform its operation.
bool	SetLevelName ( const FString& InLevelName, FText& OutFailureReason )	Sets the name of the level the consumer should move objects to if applicable.
bool	SetLevelNameAutomated ( const FString& InLevelName, FText& OutFailureReason )	Sets the name of the level the consumer should move objects to if applicable.
bool	SetLevelNameImplementation ( const FString& InLevelName, FText& OutFailureReason, const bool bIsAutomated )	Sets the name of the level the consumer should move objects to if applicable.
bool	SetTargetContentFolder ( const FString& InTargetContentFold..., FText& OutFailureReason )	Sets the path of the package the consumer should move assets to if applicable.
bool	SetTargetContentFolderAutomated ( const FString& InTargetContentFold..., FText& OutFailureReason )	Sets the path of the package the consumer should move assets to if applicable.
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
	void	PostEditUndo()	Called after applying a transaction to the object.

Classes

	Name	Description
	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

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

Take our survey

Dismiss