FAnimGroupInstance

Windows
MacOS
Linux

Syntax

struct FAnimGroupInstance

Variables

Name Description

Public variable

TArray< FAnimTi...

 

ActivePlayers

The list of animation players in this group which are going to be evaluated this frame.

Public variable

bool

 

bCanUseMarkerSync

Can we use sync markers for ticking this sync group.

Public variable

int32

 

GroupLeaderIndex

The current group leader

Public variable

FMarkerTickCont...

 

MarkerTickContext

Public variable

float

 

MontageLeaderWeight

This has latest Montage Leader Weight.

Public variable

TArray< FName >

 

ValidMarkers

Valid marker names for this sync group.

Constructors

Name Description

Public function

FAnimGroupInstance()

Functions

Name Description

Public function

void

 

Finalize

(
    const FAnimGroupInstance* Prev...
)

Called after leader has been ticked and decided.

Public function

void

 

Prepare

(
    const FAnimGroupInstance* Prev...
)

Called after all tick records have been added but before assets are actually ticked.

Public function

void

 

Reset()

Public function

void

 

TestMontageTickRecordForLeadership()

Checks the last tick record in the ActivePlayers array to see if we have a better leader for montage This is simple rule for higher weight becomes leader Only one from same sync group with highest weight will be leader

Public function

void

 

TestTickRecordForLeadership

(
    EAnimGroupRole::Type MembershipType
)

Checks the last tick record in the ActivePlayers array to see if it's a better leader than the current candidate.

References

Module

Engine

Header

Runtime/Engine/Classes/Animation/AnimationAsset.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback