1. Epic GamesDeveloper
  3. UContextualAnimSceneActorComponent

UContextualAnimSceneActorComponent

API > API/Plugins > API/Plugins/ContextualAnimation

   
Name UContextualAnimSceneActorComponent
Type class
Header File /Engine/Plugins/Experimental/Animation/ContextualAnimation/Source/ContextualAnimation/Public/ContextualAnimSceneActorComponent.h
Include Path #include "ContextualAnimSceneActorComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UContextualAnimSceneActorComponent ( const FObjectInitializer& ObjectInitializer
)

   ContextualAnimSceneActorComponent.h  

Structs

Name Remarks
FCharacterProperties  
FCharacterRotationProperties  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AlignmentOffset FTransform Optional offset from the actor transform. ContextualAnimSceneActorComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Config"
OnJoinedSceneDelegate FContextualAnimSceneActorCompDelegate Event that happens when the actor owner of this component joins an scene ContextualAnimSceneActorComponent.h
  • BlueprintAssignable
  • Category="Events"
OnLeftSceneDelegate FContextualAnimSceneActorCompDelegate Event that happens when the actor owner of this component leave an scene ContextualAnimSceneActorComponent.h
  • BlueprintAssignable
  • Category="Events"
OnMontageBlendingOutDelegate FContextualAnimOnMontageBlendingOutDelegate   ContextualAnimSceneActorComponent.h
  • BlueprintAssignable
  • Category="Events"
OnPlayMontageNotifyBeginDelegate FContextualAnimPlayMontageNotifyBeginDelegate   ContextualAnimSceneActorComponent.h
  • BlueprintAssignable
  • Category="Events"
SceneAsset TObjectPtr< class UContextualAnimSceneAsset >   ContextualAnimSceneActorComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Config"

Protected

Name Type Remarks Include Path Unreal Specifiers
AnimsPlayed TArray< TWeakObjectPtr< const UAnimMontage >, TInlineAllocator< 5 > >   ContextualAnimSceneActorComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddIKGoals_Implementation ( TMap< FName, FIKRigGoal >& OutGoals
)

   ContextualAnimSceneActorComponent.h  

void EarlyOutContextualAnimScene ( bool bStopEveryone
)

   ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

const FContextualAnimSceneBindings & GetBindings()

   ContextualAnimSceneActorComponent.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Actor Component"

const FContextualAnimIKTarget & GetIKTargetByGoalName ( FName GoalName
) const

   ContextualAnimSceneActorComponent.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Actor Component"

const TArray< FContextualAnimIKTarget > & GetIKTargets()

   ContextualAnimSceneActorComponent.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Actor Component"

bool IsInActiveScene()

   ContextualAnimSceneActorComponent.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Actor Component"

bool IsOwnerLocallyControlled()

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

bool LateJoinContextualAnimScene ( AActor* Actor,
FName Role
)

   ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

void OnIgnoredActorEndPlay ( AActor* Actor,
EEndPlayReason::Type EndPlayReason
)

   ContextualAnimSceneActorComponent.h  

void OnJoinedScene ( const FContextualAnimSceneBindings& InBindings
)

 Called when the actor owner of this component joins an scene ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

void OnLeftScene()

 Called from the scene instance when the actor owner of this component leave an scene ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"
  ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

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

   ContextualAnimSceneActorComponent.h  

bool TransitionContextualAnimScene ( FName SectionName
)

   ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

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

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

bool TransitionContextualAnimSceneToSpecificSet ( FName SectionName,
int32 AnimSetIdx
)

   ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

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

   ContextualAnimSceneActorComponent.h  

bool TransitionSingleActor ( int32 SectionIdx,
int32 AnimSetIdx
)

   ContextualAnimSceneActorComponent.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Actor Component"

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

   ContextualAnimSceneActorComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   ContextualAnimSceneActorComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetLifetimeReplicatedProps ( TArray< FLifetimeProperty >& OutLifetimeProps
) const

   ContextualAnimSceneActorComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

   ContextualAnimSceneActorComponent.h  

virtual bool CanLeaveScene ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

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 ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

void LeaveScene()

   ContextualAnimSceneActorComponent.h  

virtual void OnJoinScene ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

virtual void OnLeaveScene ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimSceneActorComponent.h  

void OnMontageBlendingOut ( UAnimMontage* Montage,
bool bInterrupted
)

   ContextualAnimSceneActorComponent.h  

void OnPlayMontageNotifyBegin ( FName NotifyName,
const FBranchingPointNotifyPayload& BranchingPointNotifyPayload
)

   ContextualAnimSceneActorComponent.h  

virtual void OnPreLeaveScene ( const FContextualAnimSceneBinding& Binding
)

 Called just before the scene leaving happens (which calls OnLeaveScene) ContextualAnimSceneActorComponent.h  

virtual void OnRep_Bindings()

   ContextualAnimSceneActorComponent.h  

void OnRep_LateJoinData()

   ContextualAnimSceneActorComponent.h  

void OnRep_RepTransitionSingleActor()

   ContextualAnimSceneActorComponent.h  

void OnRep_TransitionData()

   ContextualAnimSceneActorComponent.h  

virtual 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. ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

virtual void OtherActorLeftScene ( AActor& Actor
)

   ContextualAnimSceneActorComponent.h  

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

   ContextualAnimSceneActorComponent.h  

virtual void RestoreCollisionState ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimSceneActorComponent.h  

void RestoreMovementState ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimSceneActorComponent.h  

void ServerEarlyOutContextualAnimScene ( bool bStopEveryone
)

   ContextualAnimSceneActorComponent.h
  • Server
  • Reliable
  • WithValidation

void ServerStartContextualAnimScene ( const FContextualAnimSceneBindings& InBindings
)

   ContextualAnimSceneActorComponent.h
  • Server
  • Reliable
  • WithValidation

virtual void SetCollisionState ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimSceneActorComponent.h  

void SetIgnoreCollisionWithActor ( AActor& Actor,
bool bValue
) const

   ContextualAnimSceneActorComponent.h  

void SetIgnoreCollisionWithOtherActors ( bool bValue
) const

   ContextualAnimSceneActorComponent.h  

void SetMovementState ( const FContextualAnimSceneBinding& Binding,
const FContextualAnimTrack& AnimTrack
)

   ContextualAnimSceneActorComponent.h  

void UpdateIKTargets()

   ContextualAnimSceneActorComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   ContextualAnimSceneActorComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page