1. Epic GamesDeveloper
  3. UContextualAnimSceneActorComponent

UContextualAnimSceneActorComponent

API > API/Plugins > API/Plugins/ContextualAnimation

Inheritance Hierarchy

References

   
Module ContextualAnimation
Header /Engine/Plugins/Experimental/Animation/ContextualAnimation/Source/ContextualAnimation/Public/ContextualAnimSceneActorComponent.h
Include #include "ContextualAnimSceneActorComponent.h"

Syntax

UCLASS (Meta=(BlueprintSpawnableComponent))  
class UContextualAnimSceneActorComponent :  
    public UPrimitiveComponent ,  
    public IIKGoalCreatorInterface

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableDebug  
Protected variable UProperty Transient FContextualAnimSceneBindings Bindings Bindings for the interaction we are currently playing.
Protected variable FCharacterProperties CharacterPropertiesBackup  
Protected variable UProperty Transient TArray< FContextualAnimIKTarget > IKTargets List of IKTarget for this frame
Public variable UProperty Category BlueprintAssignable FContextualAnimSceneActorCompDelegate OnJoinedSceneDelegate Event that happens when the actor owner of this component joins an scene
Public variable UProperty Category BlueprintAssignable FContextualAnimSceneActorCompDelegate OnLeftSceneDelegate Event that happens when the actor owner of this component leave an scene
Public variable UProperty Category BlueprintAssignable FContextualAnimPlayMontageNotifyBeginDelegate OnPlayMontageNotifyBeginDelegate  
Protected variable UProperty Transient TWeakObjectPtr< UAnimInstance > OwnerAnimInstance Cache of the owner's AnimInstance for easy access. Only valid while an interaction is active
Protected variable UProperty Transient replicatedusing FContextualAnimRepBindingsData RepBindings Replicated copy of the bindings so we can start the action on simulated proxies This gets replicated only from the initiator of the action and then set on all the other members of the interaction
Protected variable UProperty Transient replicatedusing FContextualAnimRepLateJoinData RepLateJoinData  
Protected variable UProperty Transient replicatedusing FContextualAnimRepTransitionData RepTransitionData  
Protected variable UProperty Transient replicatedusing FContextualAnimRepTransitionData RepTransitionSingleActorData  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< class UContextualAnimSceneAsset > SceneAsset  
Protected variable UProperty Transient TArray< FName > WarpTargetNamesCache Motion warping doesn't remove warp targets when a warping window ends, so we keep track of the warp targets added during the interaction and remove them at the end of it to prevent issues caused by dangling warp targets after an interaction.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void  
Protected function Virtual void

AddOrUpdateWarpTargets ( int32 SectionIdx,
int32 AnimSetIdx,
const TArray< FContextualAnimWarpPoint >& WarpPoints,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function Static void  
Protected function Virtual bool  
Public function UFunction BlueprintCallable, Category void  
Public function Const UFunction BlueprintPure, Category const FContextualAnimSceneBindings &  
Public function Const UFunction BlueprintPure, Category const FContextualAnimIKTarget &  
Public function Const UFunction BlueprintPure, Category const TArray< FContextualAnimIKTarget > &  
Protected function void

HandleTransitionEveryone ( int32 NewSectionIdx,
int32 NewAnimSetIdx,
const TArray< FContextualAnimWarpPoint >& WarpPoints,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Protected function void

HandleTransitionSelf ( int32 NewSectionIdx,
int32 NewAnimSetIdx,
const TArray< FContextualAnimWarpPoint >& WarpPoints,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const bool  
Protected function void

JoinScene ( const FContextualAnimSceneBindings& InBindings,
const TArray< FContextualAnimWarpPoint > WarpPoints,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

 @TODO: These two functions are going to replace OnJoinedScene and OnLeftScene main different is that these new functions are taking care of animation playback too
Public function bool

LateJoinContextualAnimScene ( AActor* Actor,
FName Role,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function UFunction BlueprintCallable, Category bool  
Protected function void

LateJoinScene ( const FContextualAnimSceneBindings& InBindings,
int32 SectionIdx,
int32 AnimSetIdx,
const TArray< FContextualAnimWarpPoint >& WarpPoints,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Protected function void  
Public function UFunction BlueprintCallable, Category void Called when the actor owner of this component joins an scene
Protected function Virtual void  
Protected function Virtual void

OnLateJoinScene ( const FContextualAnimSceneBinding& Binding,
int32 SectionIdx,
int32 AnimSetIdx
)

  
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category void Called from the scene instance when the actor owner of this component leave an scene
Protected function UFunction void

OnMontageBlendingOut ( UAnimMontage* Montage,
bool bInterrupted
)

  
Protected function UFunction void

OnPlayMontageNotifyBegin ( FName NotifyName,
const FBranchingPointNotifyPayload& BranchingPointNotifyPayload
)

  
Protected function Virtual void Called just before the scene leaving happens (which calls OnLeaveScene)
Protected function UFunction void  
Protected function UFunction void  
Protected function UFunction void  
Protected function UFunction void  
Protected function Virtual UFunction void

OnTickPose ( USkinnedMeshComponent* SkinnedMeshComponent,
float DeltaTime,
bool bNeedsValidRootMotion
)

 Event called right before owner's mesh ticks the pose when we are in a scene instance and IK Targets are required.
Protected function Virtual void

OnTransitionScene ( const FContextualAnimSceneBinding& Binding,
int32 SectionIdx,
int32 AnimSetIdx
)

  
Protected function Virtual void

OnTransitionSingleActor ( const FContextualAnimSceneBinding& Binding,
int32 SectionIdx,
int32 AnimSetIdx
)

  
Protected function Virtual void  
Protected function Virtual void

PlayAnimation_Internal ( UAnimSequenceBase* Animation,
float StartTime,
bool bSyncPlaybackTime
)

  
Protected function Virtual void  
Protected function void  
Protected function UFunction Server, Reliable withvalidation void  
Protected function UFunction Server, Reliable withvalidation void  
Protected function Virtual void  
Protected function Const void

SetIgnoreCollisionWithActor ( AActor& Actor,
bool bValue
)

  
Protected function Const void  
Protected function void

SetMovementState ( const FContextualAnimSceneBinding& Binding,
EMovementMode DesiredMoveMode,
uint8 CustomMode
)

  
Public function UFunction BlueprintCallable, Category bool  
Public function bool

StartContextualAnimScene ( const FContextualAnimSceneBindings& InBindings,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function UFunction BlueprintCallable, Category bool  
Public function bool

TransitionContextualAnimScene ( FName SectionName,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function bool

TransitionContextualAnimScene ( FName SectionName,
int32 AnimSetIdx,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function UFunction BlueprintCallable, Category bool  
Public function bool

TransitionSingleActor ( int32 SectionIdx,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Public function UFunction BlueprintCallable, Category bool

TransitionSingleActor ( int32 SectionIdx,
int32 AnimSetIdx
)

  
Public function bool

TransitionSingleActor ( int32 SectionIdx,
int32 AnimSetIdx,
const TArray< FContextualAnimWarpTarget >& ExternalWarpTargets
)

  
Protected function void  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel

Classes

  Type Name Description
Protected struct FCharacterProperties    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page