1. Epic GamesDeveloper
  3. ACEEffectorActor

ACEEffectorActor

API > API/Plugins > API/Plugins/ClonerEffector > API/Plugins/ClonerEffector/Effector

Inheritance Hierarchy

References

   
Module ClonerEffector
Header /Engine/Plugins/Experimental/ClonerEffector/Source/ClonerEffector/Public/Effector/CEEffectorActor.h
Include #include "Effector/CEEffectorActor.h"

Syntax

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float AttractionForceFalloff  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float AttractionForceStrength  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bAttractionForceEnabled Enable attraction force to allow each clone instances to gravitate toward a location
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bCurlNoiseForceEnabled Enable curl noise force to allow each clone instance to add random location variation
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bEnabled Is this effector enabled/disabled on linked cloners
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bGravityForceEnabled Enable gravity force to pull particles based on an acceleration vector
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bOrientationForceEnabled Enable orientation force to allow each clone instance to rotate around its pivot
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite bool bVisualizerSpriteVisible Toggle the sprite to visualize and click on this effector
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bVortexForceEnabled Enable vortex force to allow each clone instance to rotate around a specific axis on the cloner pivot
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float CurlNoiseForceFrequency  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float CurlNoiseForceStrength  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter ECEClonerEasing Easing Weight easing function applied to lerp transforms
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float Frequency Intensity of the noise field
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector GravityForceAcceleration  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector InnerExtent Inner extent of box, all clones inside will be affected with a maximum weight
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float InnerRadius Inner radius of sphere, all clones inside will be affected with a maximum weight
Protected variable UProperty TWeakObjectPtr< AActor > InternalTargetActorWeak  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector LocationStrength Amplitude of the noise field for location
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float Magnitude The ratio effect of the effector on clones
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter ECEClonerEffectorMode Mode Mode of effector for each clones instances
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector Offset Offset applied on affected clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector OrientationForceMax  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector OrientationForceMin  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float OrientationForceRate  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector OuterExtent Outer extent of box, all clones outside will not be affected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float OuterRadius Outer radius of sphere, all clones outside will not be affected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector Pan Panning to offset the noise field sampling
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float PlaneSpacing Plane spacing, everything inside this zone will be affected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FRotator Rotation Rotation applied on affected clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FRotator RotationStrength Amplitude of the noise field for rotation
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector Scale Scale applied on affected clones
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FVector ScaleStrength Amplitude of the noise field for scale
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TWeakObjectPtr< AActor > TargetActorWeak The actor to track when mode is set to target
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter ECEClonerEffectorType Type Type of effector to apply on cloners instances
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite getter, setter float VisualizerThickness Thickness of components visualizers
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float VortexForceAmount  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FVector VortexForceAxis  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category float  
Protected function FCEClonerEffectorChannelData &  
Protected function Const int32  
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 ECEClonerEasing  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category ECEClonerEffectorMode

GetMode ()

  
Public function Const UFunction BlueprintPure, Category FVector  
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 float  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category FVector

GetPan ()

  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category FRotator  
Public function Const UFunction BlueprintPure, Category FRotator  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category FVector  
Public function Const UFunction BlueprintPure, Category AActor *  
Public function Const UFunction BlueprintPure, Category ECEClonerEffectorType

GetType ()

  
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 const FVector &  
Public function Const UFunction BlueprintPure, Category bool  
Protected function void Update values for box type effector
Protected function void Update values for easing
Protected function void Will update all values of this effector on all clones
Protected function void Called when we disable this effector
Protected function void

OnEffectorTransformed ( USceneComponent* InUpdatedComponent,
EUpdateTransformFlags InUpdateTransformFlags,
ETeleportType InTeleport
)

  
Protected function void Called when effector is enabled/disabled
Protected function void Called when force enabled state changed
Protected function void Called when force options are changed
Protected function void Update values for magnitude
Protected function void Update mode for this effector
Protected function void Called when noise field mode options are changed
Protected function void Update values for plane type effector
Protected function void Update values for sphere type effector
Protected function void Update actor targeted by this effector on cloners
Protected function void Called when target mode options are changed
Protected function void Called when transform of effector has changed
Protected function void Called when default mode options are changed
Protected function void Update shape type for this effector
Protected function void Update sprite visibility of this effector
Protected function void Update thickness of components of this effector
Public function UFunction BlueprintCallable, Category void

SetAttractionForceEnabled ( bool bInForceEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetAttractionForceFalloff ( float InForceFalloff
)

  
Public function UFunction BlueprintCallable, Category void

SetAttractionForceStrength ( float InForceStrength
)

  
Public function UFunction BlueprintCallable, Category void

SetCurlNoiseForceEnabled ( bool bInForceEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetCurlNoiseForceFrequency ( float InForceCurlNoiseFrequency
)

  
Public function UFunction BlueprintCallable, Category void

SetCurlNoiseForceStrength ( float InForceCurlNoiseStrength
)

  
Public function UFunction BlueprintCallable, Category void

SetEasing ( ECEClonerEasing InEasing
)

  
Public function UFunction BlueprintCallable, Category void

SetEnabled ( bool bInEnable
)

  
Public function UFunction BlueprintCallable, Category void

SetFrequency ( float InFrequency
)

  
Public function UFunction BlueprintCallable, Category void

SetGravityForceAcceleration ( const FVector& InAcceleration
)

  
Public function UFunction BlueprintCallable, Category void

SetGravityForceEnabled ( bool bInForceEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetInnerExtent ( const FVector& InExtent
)

  
Public function UFunction BlueprintCallable, Category void

SetInnerRadius ( float InRadius
)

  
Public function UFunction BlueprintCallable, Category void

SetLocationStrength ( const FVector& InStrength
)

  
Public function UFunction BlueprintCallable, Category void

SetMagnitude ( float InMagnitude
)

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

SetOffset ( const FVector& InOffset
)

  
Public function UFunction BlueprintCallable, Category void

SetOrientationForceEnabled ( bool bInForceEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetOrientationForceMax ( const FVector& InForceOrientationMax
)

  
Public function UFunction BlueprintCallable, Category void

SetOrientationForceMin ( const FVector& InForceOrientationMin
)

  
Public function UFunction BlueprintCallable, Category void

SetOrientationForceRate ( float InForceOrientationRate
)

  
Public function UFunction BlueprintCallable, Category void

SetOuterExtent ( const FVector& InExtent
)

  
Public function UFunction BlueprintCallable, Category void

SetOuterRadius ( float InRadius
)

  
Public function UFunction BlueprintCallable, Category void

SetPan ( const FVector& InPan
)

  
Public function UFunction BlueprintCallable, Category void

SetPlaneSpacing ( float InSpacing
)

  
Public function UFunction BlueprintCallable, Category void

SetRotation ( const FRotator& InRotation
)

  
Public function UFunction BlueprintCallable, Category void

SetRotationStrength ( const FRotator& InStrength
)

  
Public function UFunction BlueprintCallable, Category void

SetScale ( const FVector& InScale
)

  
Public function UFunction BlueprintCallable, Category void

SetScaleStrength ( const FVector& InStrength
)

  
Public function UFunction BlueprintCallable, Category void

SetTargetActor ( AActor* InTargetActor
)

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

SetVisualizerSpriteVisible ( bool bInVisible
)

  
Public function UFunction BlueprintCallable, Category void

SetVisualizerThickness ( float InThickness
)

  
Public function UFunction BlueprintCallable, Category void

SetVortexForceAmount ( float InForceVortexAmount
)

  
Public function UFunction BlueprintCallable, Category void

SetVortexForceAxis ( const FVector& InForceVortexAxis
)

  
Public function UFunction BlueprintCallable, Category void

SetVortexForceEnabled ( bool bInForceEnabled
)

  

Overridden from AActor

  Type Name Description
Protected function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
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.

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostDuplicate ( EDuplicateMode::Type InDuplicateMode
)

  
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Protected function Virtual void Called after applying a transaction to the object.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name Description
FOnEffectorIdentifierChanged Used to trigger a refresh on linked cloner

Constants

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