RealDocs

UAnimInstance::RecordMachineWeight

function Engine Since 4.0
#include "Animation/AnimInstance.h"
Access: public

Description

Records the overall blend weight of a state machine for the current animation update, used by debugging tools such as the animation Blueprint editor's state machine weight display.

Caveats & Gotchas

  • Purely bookkeeping for debug/inspection purposes; it does not affect evaluation or blending, so calling it with an incorrect weight only misleads the debugger, not the actual pose.
  • Called automatically by generated state machine node code — hand-authored calls are only useful when hooking custom state machine logic into the existing debug display.

Signature

void RecordMachineWeight(const int32 InMachineClassIndex, const float InMachineWeight)

Parameters

Name Type Description Default
InMachineClassIndex const int32 Index identifying the state machine within the anim Blueprint's generated class.
InMachineWeight const float The blend weight to record for this state machine for the current frame.

Return Type

void

Example

Record a state machine's weight for debugging C++
AnimInstance->RecordMachineWeight(MachineClassIndex, MachineInstance.GetGlobalWeight());

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.