UContextualAnimSceneInstance

Instance of a contextual animation scene

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UContextualAnimSceneInstance

References

Module

ContextualAnimation

Header

/Engine/Plugins/Experimental/Animation/ContextualAnimation/Source/ContextualAnimation/Public/ContextualAnimSceneInstance.h

Include

#include "ContextualAnimSceneInstance.h"

Syntax

UCLASS(BlueprintType, Blueprintable)
class UContextualAnimSceneInstance : public UObject

Remarks

Instance of a contextual animation scene

Variables

Name Description

Public variable

TArray< TTuple<...

 

AlignmentSectionToScenePivotList

List of alignment section to scene pivot

Public variable

FOnContextualAn...

 

OnActorJoined

Delegate to notify external objects when an actor join

Public variable

FOnContextualAn...

 

OnActorLeft

Delegate to notify external objects when an actor leave

Public variable

FOnContextualAn...

 

OnSceneEnded

Delegate to notify external objects when this is scene is completed

Public variable UProperty

TMap< FName, FC...

 

SceneActorMap

Map of roles to scene actor

Public variable UProperty

TObjectPtr< con...

 

SceneAsset

Scene asset this instance was created from

Constructors

Name Description

Public function

UContextualAnimSceneInstance

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

BreakContextualAnimSceneActorData

(
    const FContextualAnimSceneActorData...,
    AActor*& Actor,
    UAnimMontage*& Montage,
    float& AnimTime,
    int32& CurrentSectionIndex,
    FName& CurrentSectionName
)

Extracts data from a ContextualAnimSceneActorData

Public function Const UFunction BlueprintCallable, Category

bool

 

DidCurrentSectionLoop()

Public function Const

const FConte...

 

FindSceneActorDataForActor

(
    const AActor* Actor
)

Public function Const

const FConte...

 

FindSceneActorDataForRole

(
    const FName& Role
)

Public function Const UFunction BlueprintCallable, Category

AActor *

 

GetActorByRole

(
    FName Role
)

Public function Const UFunction BlueprintCallable, Category

float

 

GetCurrentSectionTimeLeft()

Public function Const UFunction BlueprintCallable, Category

float

 

GetPositionInCurrentSection()

Public function Const UFunction Category blueprintnativeevent

float

 

GetResumePositionForSceneActor

(
    const FContextualAnimSceneActorData...,
    int32 DesiredSectionIndex
)

Public function Virtual Const

UWorld *

 

GetWorld()

Public function Const

bool

 

IsActorInThisScene

(
    const AActor* Actor
)

Whether the supplied actor is part of this scene

Protected function

void

 

Join

(
    FContextualAnimSceneActorData& Sce...
)

Tells the scene actor to join the scene (play animation)

Protected function

void

 

Leave

(
    FContextualAnimSceneActorData& Sce...
)

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 ...
)

Protected function UFunction

void

 

OnNotifyEndReceived

(
    FName NotifyName,
    const FBranchingPointNotifyPayload ...
)

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

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

bool

 

TransitionTo

(
    FContextualAnimSceneActorData& Sce...,
    const FName& ToSectionName
)

Protected function

void

 

UpdateTransitions

(
    float DeltaTime
)