1. Epic GamesDeveloper
  3. UContextualAnimSceneInstance

UContextualAnimSceneInstance

Instance of a contextual animation scene

API > API/Plugins > API/Plugins/ContextualAnimation

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Blueprintable&41;  
class UContextualAnimSceneInstance : public UObject

Remarks

Instance of a contextual animation scene

Variables

  Type Name Description
Public variable UProperty BlueprintAssignable FOnContextualAnimSceneActorJoined OnActorJoined Delegate to notify external objects when an actor join
Public variable UProperty BlueprintAssignable FOnContextualAnimSceneActorLeft OnActorLeft Delegate to notify external objects when an actor leave
Public variable UProperty BlueprintAssignable FOnContextualAnimSceneNotify OnNotifyBegin Delegate to notify external objects when an animation hits a 'PlayMontageNotify' or 'PlayMontageNotifyWindow' begin
Public variable UProperty BlueprintAssignable FOnContextualAnimSceneNotify OnNotifyEnd Delegate to notify external objects when an animation hits a 'PlayMontageNotify' or 'PlayMontageNotifyWindow' end
Public variable UProperty BlueprintAssignable FOnContextualAnimSceneEnded OnSceneEnded Delegate to notify external objects when this is scene is completed after all montages played by the scene section blended out.
Public variable UProperty BlueprintAssignable FOnContextualAnimSceneEnded OnSectionEndTimeReached Delegate to notify once the scene play time reaches the duration defined by the longest played montage of the selected section.

Constructors

  Type Name Description
Public function  

UContextualAnimSceneInstance ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const const FContextualAnimSceneBinding *

FindBindingByActor ( const AActor* Actor
)

  
Public function Const const FContextualAnimSceneBinding *

FindBindingByRole ( const FName& Role
)

  
Public function bool

ForceTransitionToSection ( const int32 SectionIdx,
const int32 AnimSetIdx,
const TArray< FContextualAnimWarpPoint >& InWarpPoints
)

 Tells current scene instance to transition to a different section.
Public function Const UFunction BlueprintCallable, Category AActor *  
Public function Const const FContextualAnimSceneBindings &  
Public function FContextualAnimSceneBindings &  
Protected function TArray< FContextualAnimWarpPoint > &  
Public function Const const UContextualAnimSceneAsset &  
Public function Virtual Const UWorld *  
Public function Const bool

IsActorInThisScene ( const AActor* Actor
)

 Whether the supplied actor is part of this scene
Public function Const bool  
Protected function float Tells the scene actor to join the scene (play animation)
Protected function void Tells the scene actor to leave the scene (stop animation)
Protected function UFunction void

OnMontageBlendingOut ( UAnimMontage* Montage,
bool bInterrupted
)

  
Protected function UFunction void

OnNotifyBeginReceived ( FName NotifyName,
const FBranchingPointNotifyPayload& BranchingPointNotifyPayload
)

  
Protected function UFunction void

OnNotifyEndReceived ( FName NotifyName,
const FBranchingPointNotifyPayload& BranchingPointNotifyPayload
)

  
Protected function Const void

SetIgnoreCollisionWithOtherActors ( AActor* Actor,
bool bValue
)

 Helper function to set ignore collision between the supplied actor and all the other actors in this scene
Protected function void

SetWarpPoints ( const TArray< FContextualAnimWarpPoint >& InWarpPoints
)

  
Public function void

Start ()

 Resolve initial alignment and start playing animation for all actors
Public function void

Stop ()

 Force all the actors to leave the scene
Public function void

Tick ( float DeltaTime
)

  
Protected function float  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page