UAnimInstance::GetMutableInstanceRelevantAssetPlayers

function Engine Since 4.11

#include "Animation/AnimInstance.h"

Access: public Specifiers: ENGINE_API

Description

Returns a mutable reference to the array of relevant asset player tick records. Allows modification of only the asset players that are actively contributing to the final pose.

Caveats & Gotchas

• Modifications must happen during the correct animation update phase. Writing to this array during or after evaluation causes undefined behaviour because the evaluation pipeline has already consumed the tick records.
• The relevant set is rebuilt each frame, so any changes are transient and must be reapplied every update cycle.

Signature

ENGINE_API TArray<FAnimTickRecord>& GetMutableInstanceRelevantAssetPlayers();

Return Type

TArray<FAnimTickRecord>&

Example

Scale playback rate of relevant players C++

TArray<FAnimTickRecord>& Relevant = AnimInstance->GetMutableInstanceRelevantAssetPlayers();
for (FAnimTickRecord& Record : Relevant)
{
    Record.PlayRateMultiplier *= GlobalTimeScale;
}

Version History

Introduced in: 4.11

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?