1. Epic GamesDeveloper
  3. UAvaAutoFollowModifier

UAvaAutoFollowModifier

Moves the modifying actor along with a specified actor relative to the specified actor's bounds.

API > API/Plugins > API/Plugins/AvalancheModifiers > API/Plugins/AvalancheModifiers/Modifiers

Inheritance Hierarchy

References

   
Module AvalancheModifiers
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheModifiers/Public/Modifiers/AvaAutoFollowModifier.h
Include #include "Modifiers/AvaAutoFollowModifier.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UAvaAutoFollowModifier :  
    public UAvaAttachmentBaseModifier ,  
    public IAvaTransformUpdateHandler ,  
    public IAvaRenderStateUpdateHandler

Remarks

Moves the modifying actor along with a specified actor relative to the specified actor's bounds.

Variables

  Type Name Description
Protected variable UProperty Category, Interp, Meta displayname, editinstanceonly, getter, setter FVector DefaultDistance The distance from this actor to the followed actor.
Protected variable UProperty Category, Meta editinstanceonly, getter, setter FAvaAnchorAlignment FollowedAlignment The alignment for the followed actor's center.
Protected variable UProperty Category, Meta editinstanceonly, getter, setter int32 FollowedAxis Which axis should we follow
Protected variable UProperty Category, Meta editinstanceonly, getter, setter FAvaAnchorAlignment LocalAlignment The alignment for this actor's center.
Protected variable UProperty Category, Interp, Meta displayname, editinstanceonly, getter, setter FVector MaxDistance The maximum distance from this actor to the followed actor.
Protected variable UProperty Category, Interp, Meta editinstanceonly, getter, setter FVector OffsetAxis Based on followed axis, the direction to offset this actor from the followed actor's bounds.
Protected variable UProperty Category, Interp, Meta displayname, editinstanceonly, getter, setter FVector Progress Percent % progress from the maximum distance to the default distance.
Protected variable UProperty Category, Meta editinstanceonly, getter, setter FAvaSceneTreeActor ReferenceActor  

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category FVector Gets the distance from this actor to the followed actor.
Public function Const UFunction BlueprintPure, Category FAvaAnchorAlignment Gets the alignment for the followed actor's center.
Public function Const UFunction BlueprintPure, Category int32  
Public function Const UFunction BlueprintPure, Category FAvaAnchorAlignment Gets the alignment for this actor's center.
Public function Const UFunction BlueprintPure, Category FVector Gets the maximum distance from this actor to the followed actor.
Public function Const UFunction BlueprintPure, Category FVector Gets the axis direction to offset this actor from the followed actor's bounds.
Public function Const UFunction BlueprintPure, Category FVector Gets the percent % progress from the maximum distance to the default distance.
Public function Const UFunction BlueprintPure, Category const FAvaSceneTreeActor &  
Protected function void  
Protected function void  
Protected function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

  
Public function UFunction BlueprintCallable, Category void

SetDefaultDistance ( const FVector& InDefaultDistance
)

 Sets the distance from this actor to the followed actor.
Public function UFunction BlueprintCallable, Category void

SetFollowedAlignment ( const FAvaAnchorAlignment& InFollowedAlignment
)

 Sets the alignment for the followed actor's center.
Public function UFunction BlueprintCallable, Category void

SetFollowedAxis ( int32 InFollowedAxis
)

  
Public function UFunction BlueprintCallable, Category void

SetLocalAlignment ( const FAvaAnchorAlignment& InLocalAlignment
)

 Sets the alignment for this actor's center.
Public function UFunction BlueprintCallable, Category void

SetMaxDistance ( const FVector& InMaxDistance
)

 Sets the maximum distance from this actor to the followed actor.
Public function UFunction BlueprintCallable, Category void

SetOffsetAxis ( const FVector& InOffsetAxis
)

 Sets the axis direction to offset this actor from the followed actor's bounds.
Public function UFunction BlueprintCallable, Category void

SetProgress ( const FVector& InProgress
)

 Sets the percent % progress from the maximum distance to the default distance.
Public function UFunction BlueprintCallable, Category void

SetReferenceActor ( const FAvaSceneTreeActor& InReferenceActor
)

  

Overridden from UActorModifierCoreBase

  Type Name Description
Protected function Virtual void

Apply ()

 Override in child classes, apply this modifier on the actual actor, call Next or Fail to complete the modifier execution
Protected function Virtual Const bool You can do additional lightweights checks here in case you want to dirty the modifier instead of waiting for an event, tick must be enabled in the metadata
Protected function Virtual void Called when modified actor transform is updated if this modifier is enabled
Protected function Virtual void Called after the modifier was added to a stack and initialized after creation or serialization or duplication
Protected function Virtual void Override metadata for this modifier, called only once before modifier CDO is registered
Protected function Virtual void Called when a modifier is disabled
Protected function Virtual void Called when a modifier is enabled
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual void  

Overridden from IAvaSceneTreeUpdateHandler

  Type Name Description
Protected function Virtual void

OnSceneTreeTrackedActorChanged ( int32 InIdx,
AActor* InPreviousActor,
AActor* InNewActor
)

  
Protected function Virtual void

OnSceneTreeTrackedActorChildrenChanged ( int32 InIdx,
const TSet< TWeakObjectPtr< AActor > >& InPreviousChildrenActors,
const TSet< TWeakObjectPtr< AActor > >& InNewChildrenActors
)

  

Overridden from IAvaTransformUpdateHandler

  Type Name Description
Protected function Virtual void

OnTransformUpdated ( AActor* InActor,
bool bInParentMoved
)

 Callback when a tracked actor transform changes

Overridden from IAvaRenderStateUpdateHandler

  Type Name Description
Protected function Virtual void Callback when a tracked actor visibility has changed
Protected function Virtual void

OnRenderStateUpdated ( AActor* InActor,
UActorComponent* InComponent
)

 Callback when a render state actor in this world changes

Deprecated Variables

  Type Name Description
Protected variable UProperty Meta bool bIgnoreHiddenActors_DEPRECATED If true, will search for the next visible actor based on the selected reference container.
Protected variable UProperty Meta TWeakObjectPtr< AActor > ReferenceActorWeak_DEPRECATED The actor being followed by the modifier.
Protected variable UProperty Meta EAvaReferenceContainer ReferenceContainer_DEPRECATED The method for finding a reference actor based on it's position in the parent's hierarchy.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page