Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FAnimGroupInstance |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Animation/AnimationAsset.h |
| Include Path | #include "Animation/AnimationAsset.h" |
Syntax
USTRUCT ()
struct FAnimGroupInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAnimGroupInstance() |
Animation/AnimationAsset.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActivePlayers | TArray< FAnimTickRecord > | The list of animation players in this group which are going to be evaluated this frame. | Animation/AnimationAsset.h | |
| AnimLengthRatio | float | Float in 0 - 1 range representing how far through an animation we are. | Animation/AnimationAsset.h | |
| bCanUseMarkerSync | bool | Can we use sync markers for ticking this sync group. | Animation/AnimationAsset.h | |
| GroupLeaderIndex | int32 | The current group leader | Animation/AnimationAsset.h | |
| MarkerTickContext | FMarkerTickContext | Animation/AnimationAsset.h | ||
| MontageLeaderWeight | float | This has latest Montage Leader Weight. | Animation/AnimationAsset.h | |
| PreviousAnimLengthRatio | float | Float in 0 - 1 range representing how far through an animation we were before ticking. | Animation/AnimationAsset.h | |
| ValidMarkers | TArray< FName > | Valid marker names for this sync group. | Animation/AnimationAsset.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Finalize
(
const FAnimGroupInstance* PreviousGroup |
Called after leader has been ticked and decided. | Animation/AnimationAsset.h | |
void Prepare
(
const FAnimGroupInstance* PreviousGroup |
Called after all tick records have been added but before assets are actually ticked. | Animation/AnimationAsset.h | |
void Reset() |
Animation/AnimationAsset.h | ||
void TestMontageTickRecordForLeadership() |
Animation/AnimationAsset.h | ||
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. | Animation/AnimationAsset.h |