1. Epic GamesDeveloper
  3. ACEClonerActor

ACEClonerActor

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI, BlueprintType,  
       HideCategories=(Rendering, Replication, Collision, HLOD, Physics, Networking, Input, Actor, Cooking, LevelInstance, Streaming),  
       DisplayName="Motion Design Cloner Actor")  
class ACEClonerActor : public AActor

Variables

  Type Name Description
Protected variable UProperty Category, Meta BlueprintReadOnly Transient duplicatetransient, instanced, visibleinstanceonly TObjectPtr< UCEClonerLayoutBase > ActiveLayout Active layout
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite displayname, getter, setter bool bDeltaStepEnabled Enable steps to add delta variation on each clone instance
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bEnabled Is this cloner enabled/disabled
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bInvertProgress Invert progress behaviour
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite displayname, getter, setter bool bLifetimeEnabled Do we destroy the clones after a specific duration
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter bool bLifetimeScaleEnabled Enable scale by lifetime
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bMeshCastShadows Whether clones cast shadow, disabling will result in better performance
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite displayname, getter, setter bool bRangeEnabled Use random range transforms for each clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter bool bRangeScaleUniform  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bReduceMotionGhosting Reduces the r.TSR.ShadingRejection.Flickering.Period from 3 (default) to 1 if enabled to avoid ghosting artifacts when moving
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bVisualizerSpriteVisible Toggle the sprite to visualize and click on this cloner
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter TArray< TObjectPtr< UStaticMesh > > DefaultMeshes When nothing is attached to the cloner, these meshes are used as default
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FRotator DeltaStepRotation Amount of rotation difference between one step and the next one
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FVector DeltaStepScale Amount of scale difference between one step and the next one
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FName LayoutName Name of the layout to use
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter float LifetimeMax Maximum lifetime for a clone
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter float LifetimeMin Minimum lifetime for a clone
Protected variable UProperty getter, setter FRichCurve LifetimeScaleCurve  
Protected variable UProperty Transient duplicatetransient, textexporttransient TWeakObjectPtr< UNiagaraDataInterfaceCurve > LifetimeScaleCurveDIWeak Used to expose the scale curve editor in details panel
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter ENiagaraMeshFacingMode MeshFacingMode Mode to indicate how clones facing is determined
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter ECEClonerMeshRenderMode MeshRenderMode Indicates how we select the mesh to render on each clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float Progress Changes visibility of instances based on the total count, 1.f = 100% = all instances visible
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FVector RangeOffsetMax  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FVector RangeOffsetMin  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FRotator RangeRotationMax  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FRotator RangeRotationMin  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FVector RangeScaleMax  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter FVector RangeScaleMin  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter float RangeScaleUniformMax  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter float RangeScaleUniformMin  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter int32 Seed Cloner instance seed for random deterministic patterns
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite displayname, getter, setter ECEClonerSpawnBehaviorMode SpawnBehaviorMode How does spawn occurs
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter float SpawnLoopInterval Interval/Duration of spawn for clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter int32 SpawnLoopIterations Amount of spawn iterations for clones
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite displayname, getter, setter ECEClonerSpawnLoopMode SpawnLoopMode How many times do we spawn clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname, getter, setter float SpawnRate How many clones to spawn each seconds
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite getter, setter float TreeUpdateInterval Interval to update the attachment tree and update the cloner meshes

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category, Meta TArray< UStaticMesh * >  
Public function UFunction BlueprintCallable, Category, Meta void

BP_SetDefaultMeshes ( const TArray< UStaticMesh* >& InMeshes
)

  
Public function UFunction Category callineditor void This will force an update of the cloner attachment tree
Protected function void For each valid effector that has this cloner registered
Public function Const UFunction BlueprintPure, Category UCEClonerLayoutBase *  
Public function Const InLayoutClass *  
Protected function Const UCEClonerComponent *  
Public function Const const TArray< TObjectPtr< UStaticMesh > > &  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category FRotator  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category int32 Gets the number of effectors applied on this cloner
Protected function Const const FCEClonerEffectorDataInterfaces * Used by effector actors to apply transformations to this cloner instances
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category FName  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction const FRichCurve &  
Protected function Const UNiagaraDataInterfaceCurve *  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category int32 Returns the number of meshes this cloner currently handles
Public function Const UFunction BlueprintPure, Category ENiagaraMeshFacingMode  
Public function Const UFunction BlueprintPure, Category ECEClonerMeshRenderMode  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category const FVector &  
Public function Const UFunction BlueprintPure, Category const FVector &  
Public function Const UFunction BlueprintPure, Category const FRotator &  
Public function Const UFunction BlueprintPure, Category const FRotator &  
Public function Const UFunction BlueprintPure, Category const FVector &  
Public function Const UFunction BlueprintPure, Category const FVector &  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category int32

GetSeed ()

  
Public function Const UFunction BlueprintPure, Category ECEClonerSpawnBehaviorMode  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category int32  
Public function Const UFunction BlueprintPure, Category ECEClonerSpawnLoopMode  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category float  
Public function Const bool  
Protected function Const bool  
Public function Const bool

IsEffectorLinked ( const ACEEffectorActor* InEffector
)

 Checks if an effector is linked with this cloner
Public function bool

LinkEffector ( ACEEffectorActor* InEffector
)

 Links a new effector to apply transformation on clones
Protected function void

OnClonerMeshUpdated ( UCEClonerComponent* InClonerComponent
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

OnEffectorIdentifierChanged ( ACEEffectorActor* InEffector,
int32 InOldIdentifier,
int32 InNewIdentifier
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void Update sprite visibility of this cloner
Protected function void

RequestClonerUpdate ( bool bInImmediate
)

 Will force a system update to refresh user parameters
Public function void

SetDefaultMeshes ( const TArray< TObjectPtr< UStaticMesh > >& InMeshes
)

  
Public function UFunction BlueprintCallable, Category void

SetDeltaStepEnabled ( bool bInEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetDeltaStepRotation ( const FRotator& InRotation
)

  
Public function UFunction BlueprintCallable, Category void

SetDeltaStepScale ( const FVector& InScale
)

  
Public function UFunction BlueprintCallable, Category void

SetEnabled ( bool bInEnable
)

  
Public function UFunction BlueprintCallable, Category void

SetInvertProgress ( bool bInInvertProgress
)

  
Public function UFunction BlueprintCallable, Category void

SetLayoutName ( FName InLayoutName
)

  
Public function UFunction BlueprintCallable, Category void

SetLifetimeEnabled ( bool bInEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetLifetimeMax ( float InMax
)

  
Public function UFunction BlueprintCallable, Category void

SetLifetimeMin ( float InMin
)

  
Public function UFunction void

SetLifetimeScaleCurve ( const FRichCurve& InCurve
)

  
Public function UFunction BlueprintCallable, Category void

SetLifetimeScaleEnabled ( bool bInEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetMeshCastShadows ( bool InbCastShadows
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetProgress ( float InProgress
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeEnabled ( bool bInRangeEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeOffsetMax ( const FVector& InRangeOffsetMax
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeOffsetMin ( const FVector& InRangeOffsetMin
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeRotationMax ( const FRotator& InRangeRotationMax
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeRotationMin ( const FRotator& InRangeRotationMin
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeScaleMax ( const FVector& InRangeScaleMax
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeScaleMin ( const FVector& InRangeScaleMin
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeScaleUniform ( bool bInRangeScaleUniform
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeScaleUniformMax ( float InRangeScaleUniformMax
)

  
Public function UFunction BlueprintCallable, Category void

SetRangeScaleUniformMin ( float InRangeScaleUniformMin
)

  
Public function UFunction BlueprintCallable, Category void

SetSeed ( int32 InSeed
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetSpawnLoopInterval ( float InInterval
)

  
Public function UFunction BlueprintCallable, Category void

SetSpawnLoopIterations ( int32 InIterations
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetSpawnRate ( float InRate
)

  
Public function UFunction BlueprintCallable, Category void

SetTreeUpdateInterval ( float InInterval
)

  
Public function void When the cloner actor is created, we spawn a default actor attached
Public function UFunction Category callineditor void This will spawn an effector actor and link it to this cloner
Public function bool Unlinks the effector and reset the cloner simulation
Protected function void  

Overridden from AActor

  Type Name Description
Protected function Virtual Const FString Returns this actor's default label (does not include any numeric suffix).
Protected function Virtual void Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.
Protected function Virtual Const bool Allow ticking in editor viewport too
Protected function Virtual void

Tick ( float DeltaSeconds
)

 Tick needed to keep the attachment tree updated

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after applying a transaction to the object.
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

Constants

Name Description
DefaultLabel  
PropertyChangeDispatcher Used for PECP

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page