Navigation
API > API/Plugins > API/Plugins/ClonerEffector > API/Plugins/ClonerEffector/Effector
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- AActor
- ACEEffectorActor
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 | |
|---|---|---|---|
| float | AttractionForceFalloff | ||
| float | AttractionForceStrength | ||
| bool | bAttractionForceEnabled | Enable attraction force to allow each clone instances to gravitate toward a location | |
| bool | bCurlNoiseForceEnabled | Enable curl noise force to allow each clone instance to add random location variation | |
| bool | bEnabled | Is this effector enabled/disabled on linked cloners | |
| bool | bGravityForceEnabled | Enable gravity force to pull particles based on an acceleration vector | |
| bool | bOrientationForceEnabled | Enable orientation force to allow each clone instance to rotate around its pivot | |
| bool | bVisualizerSpriteVisible | Toggle the sprite to visualize and click on this effector | |
| bool | bVortexForceEnabled | Enable vortex force to allow each clone instance to rotate around a specific axis on the cloner pivot | |
| float | CurlNoiseForceFrequency | ||
| float | CurlNoiseForceStrength | ||
| ECEClonerEasing | Easing | Weight easing function applied to lerp transforms | |
| float | Frequency | Intensity of the noise field | |
| FVector | GravityForceAcceleration | ||
| FVector | InnerExtent | Inner extent of box, all clones inside will be affected with a maximum weight | |
| float | InnerRadius | Inner radius of sphere, all clones inside will be affected with a maximum weight | |
| TWeakObjectPtr< AActor > | InternalTargetActorWeak | ||
| FVector | LocationStrength | Amplitude of the noise field for location | |
| float | Magnitude | The ratio effect of the effector on clones | |
| ECEClonerEffectorMode | Mode | Mode of effector for each clones instances | |
| FVector | Offset | Offset applied on affected clones | |
| FVector | OrientationForceMax | ||
| FVector | OrientationForceMin | ||
| float | OrientationForceRate | ||
| FVector | OuterExtent | Outer extent of box, all clones outside will not be affected | |
| float | OuterRadius | Outer radius of sphere, all clones outside will not be affected | |
| FVector | Pan | Panning to offset the noise field sampling | |
| float | PlaneSpacing | Plane spacing, everything inside this zone will be affected | |
| FRotator | Rotation | Rotation applied on affected clones | |
| FRotator | RotationStrength | Amplitude of the noise field for rotation | |
| FVector | Scale | Scale applied on affected clones | |
| FVector | ScaleStrength | Amplitude of the noise field for scale | |
| TWeakObjectPtr< AActor > | TargetActorWeak | The actor to track when mode is set to target | |
| ECEClonerEffectorType | Type | Type of effector to apply on cloners instances | |
| float | VisualizerThickness | Thickness of components visualizers | |
| float | VortexForceAmount | ||
| FVector | VortexForceAxis |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | |||
| float | |||
| float | |||
| FCEClonerEffectorChannelData & | |||
| int32 | |||
| bool | |||
| float | |||
| float | |||
| ECEClonerEasing | GetEasing () |
||
| bool | GetEnabled () |
||
| float | GetFrequency () |
||
| FVector | |||
| bool | |||
| FVector | |||
| float | |||
| FVector | |||
| float | GetMagnitude () |
||
| ECEClonerEffectorMode | GetMode () |
||
| FVector | GetOffset () |
||
| bool | |||
| const FVector & | |||
| const FVector & | |||
| float | |||
| FVector | |||
| float | |||
| FVector | GetPan () |
||
| float | |||
| FRotator | GetRotation () |
||
| FRotator | |||
| FVector | GetScale () |
||
| FVector | |||
| AActor * | |||
| ECEClonerEffectorType | GetType () |
||
| bool | |||
| float | |||
| float | |||
| const FVector & | |||
| bool | |||
| void | OnBoxChanged () |
Update values for box type effector | |
| void | Update values for easing | ||
| void | Will update all values of this effector on all clones | ||
| void | Called when we disable this effector | ||
| void | OnEffectorTransformed
(
USceneComponent* InUpdatedComponent, |
||
| void | Called when effector is enabled/disabled | ||
| void | Called when force enabled state changed | ||
| void | Called when force options are changed | ||
| void | Update values for magnitude | ||
| void | Update mode for this effector | ||
| void | Called when noise field mode options are changed | ||
| void | Update values for plane type effector | ||
| void | Update values for sphere type effector | ||
| void | Update actor targeted by this effector on cloners | ||
| void | Called when target mode options are changed | ||
| void | Called when transform of effector has changed | ||
| void | Called when default mode options are changed | ||
| void | Update shape type for this effector | ||
| void | Update sprite visibility of this effector | ||
| void | Update thickness of components of this effector | ||
| void | SetAttractionForceEnabled
(
bool bInForceEnabled |
||
| void | SetAttractionForceFalloff
(
float InForceFalloff |
||
| void | SetAttractionForceStrength
(
float InForceStrength |
||
| void | SetCurlNoiseForceEnabled
(
bool bInForceEnabled |
||
| void | SetCurlNoiseForceFrequency
(
float InForceCurlNoiseFrequency |
||
| void | SetCurlNoiseForceStrength
(
float InForceCurlNoiseStrength |
||
| void | SetEasing
(
ECEClonerEasing InEasing |
||
| void | SetEnabled
(
bool bInEnable |
||
| void | SetFrequency
(
float InFrequency |
||
| void | SetGravityForceAcceleration
(
const FVector& InAcceleration |
||
| void | SetGravityForceEnabled
(
bool bInForceEnabled |
||
| void | SetInnerExtent
(
const FVector& InExtent |
||
| void | SetInnerRadius
(
float InRadius |
||
| void | SetLocationStrength
(
const FVector& InStrength |
||
| void | SetMagnitude
(
float InMagnitude |
||
| void | SetMode
(
ECEClonerEffectorMode InMode |
||
| void | |||
| void | SetOrientationForceEnabled
(
bool bInForceEnabled |
||
| void | SetOrientationForceMax
(
const FVector& InForceOrientationMax |
||
| void | SetOrientationForceMin
(
const FVector& InForceOrientationMin |
||
| void | SetOrientationForceRate
(
float InForceOrientationRate |
||
| void | SetOuterExtent
(
const FVector& InExtent |
||
| void | SetOuterRadius
(
float InRadius |
||
| void | |||
| void | SetPlaneSpacing
(
float InSpacing |
||
| void | SetRotation
(
const FRotator& InRotation |
||
| void | SetRotationStrength
(
const FRotator& InStrength |
||
| void | |||
| void | SetScaleStrength
(
const FVector& InStrength |
||
| void | SetTargetActor
(
AActor* InTargetActor |
||
| void | SetType
(
ECEClonerEffectorType InType |
||
| void | SetVisualizerSpriteVisible
(
bool bInVisible |
||
| void | SetVisualizerThickness
(
float InThickness |
||
| void | SetVortexForceAmount
(
float InForceVortexAmount |
||
| void | SetVortexForceAxis
(
const FVector& InForceVortexAxis |
||
| void | SetVortexForceEnabled
(
bool bInForceEnabled |
Overridden from AActor
| Type | Name | Description | |
|---|---|---|---|
| void | Destroyed () |
Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending | |
| FString | Returns this actor's default label (does not include any numeric suffix). | ||
| 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 | |
|---|---|---|---|
| void | PostDuplicate
(
EDuplicateMode::Type InDuplicateMode |
||
| void | PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
Called when a property on this object has been modified externally | |
| 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 | ||
| void | PostEditUndo () |
Called after applying a transaction to the object. | |
| void | PostLoad () |
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 |