UCEClonerLayoutBase | Unreal Engine 5.4 Documentation

API > API/Plugins > API/Plugins/ClonerEffector > API/Plugins/ClonerEffector/Cloner > API/Plugins/ClonerEffector/Cloner/Layouts

Inheritance Hierarchy

References


Module	ClonerEffector
Header	/Engine/Plugins/Experimental/ClonerEffector/Source/ClonerEffector/Public/Cloner/Layouts/CEClonerLayoutBase.h
Include	#include "Cloner/Layouts/CEClonerLayoutBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, Within=CEClonerActor, AutoExpandCategories=("Layout"))  
class UCEClonerLayoutBase : public UObject

Remarks

Base class for layouts available in the cloner actor Steps to add a new layout :

Create a new system that extends from NS_ClonerBase and expose all the parent parameters (examples can be found in Content)

Extend this layout class and give it a unique name with the newly created system path

Expose all new system specific parameters in the layout extended class and update them when required Your new layout is ready and will be available in the cloner in the layout dropdown

Constructors

	Type	Name	Description
		UCEClonerLayoutBase ()
		UCEClonerLayoutBase ( const FName& InLayoutName, const FString& InLayoutAssetPath )

Functions

Type	Name	Description
bool	ActivateLayout ()	Activate this layout system on the cloner, must be loaded first
bool	CopyTo ( UCEClonerLayoutBase* InOtherLayout )	Copies this layout data interfaces to other layout
bool	DeactivateLayout ()	Deactivate this layout system if active
ACEClonerActor *	GetClonerActor ()	Get the cloner actor using this layout
UCEClonerComponent *	GetClonerComponent ()	Get the cloner component using this layout
const FCEClonerEffectorDataInterfaces &	GetDataInterfaces ()
FString	GetLayoutAssetPath ()
FName	GetLayoutName ()
UNiagaraMeshRendererProperties *	GetMeshRenderer ()
UNiagaraSystem *	GetSystem ()
bool	IsLayoutActive ()	Is this layout system in use within the cloner
bool	IsLayoutLoaded ()	Is this layout system cached and ready to be used
bool	IsLayoutValid ()	Checks if the niagara system asset is valid and usable with the cloner
bool	LoadLayout ()	Load this layout system if not already loaded
void	OnLayoutActive ()	Called after layout becomes active
void	OnLayoutInactive ()	Called after layout becomes inactive
void	OnLayoutLoaded ()	Called once after layout is loaded
void	OnLayoutParametersChanged ( UCEClonerComponent* InComponent )	Called to reapply layout parameters
void	OnLayoutPropertyChanged ()
void	OnLayoutUnloaded ()	Called once after layout is unloaded
void	RequestClonerUpdate ( bool bInImmediate )	Updates the cloner, forcing a reset of the system
bool	UnloadLayout ()	Free the loaded system and return to idle state
void	UpdateLayoutParameters ( bool bInUpdateCloner, bool bInImmediate )	Request refresh layout next tick

Constants

Name	Description
LayoutBaseAssetPath

Navigation