UKismetAnimationLibrary

class AnimGraphRuntime Blueprint Since 4.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetAnimationLibrary

#include "KismetAnimationLibrary.h"

Description

A library of the most common animation Blueprint functions, exposed to Animation Blueprints and general Blueprint graphs alike — two-bone IK, look-at, socket distance/direction queries, Perlin noise, and velocity-from-history helpers.

Caveats & Gotchas

• Marked BlueprintThreadSafe at the class level, so most of these nodes can run inside the Anim Graph's worker-thread evaluation — but a few individual functions are explicitly flagged NotBlueprintThreadSafe (e.g. the socket/bone distance and direction queries) because they touch USkeletalMeshComponent state that isn't safe off the game thread.
• Functions prefixed K2_ are the Blueprint-facing wrappers; the Blueprint node names shown in the graph (via ScriptName/DisplayName meta) often differ from the C++ function name.

Functions (11)

Utilities 11

Utilities

11 ▼

Access	Type	Name	Description
public	function	UKismetAnimationLibrary::CalculateDirection	Returns the signed angle in degrees between Velocity and the forward vector of BaseRotation, in the range [-180, 180].
public	function	UKismetAnimationLibrary::K2_CalculateVelocityFromPositionHistory	Tracks a position over successive calls and returns a smoothed scalar velocity magnitude, optionally normalized into a 0-1 range.
public	function	UKismetAnimationLibrary::K2_MakePerlinNoiseAndRemap	Samples 1D Perlin noise at Value and remaps the result into the given output range.
public	function	UKismetAnimationLibrary::K2_MakePerlinNoiseVectorAndRemap	Samples 3D Perlin noise at (X, Y, Z) independently per axis and remaps each resulting component into its own output range.
public	function	UKismetAnimationLibrary::K2_CalculateVelocityFromSockets	Tracks the motion of an offset position on a bone/socket over time — optionally relative to another bone/socket as a moving reference frame — and returns a smoothed, optionally eased velocity magnitude.
public	function	UKismetAnimationLibrary::K2_DirectionBetweenSockets	Returns the normalized world-space direction vector from one named socket/bone to another on a skeletal mesh.
public	function	UKismetAnimationLibrary::K2_DistanceBetweenTwoSocketsAndMapRange	Computes the distance between two named sockets or bones on a skeletal mesh, optionally remapping the raw distance into a normalized output range for driving things like blend weights.
public	function	UKismetAnimationLibrary::K2_EndProfilingTimer	Ends the profiling bracket started by K2_StartProfilingTimer and returns the elapsed time in milliseconds, optionally logging it to the Output Log.
public	function	UKismetAnimationLibrary::K2_LookAt	Returns a copy of CurrentTransform rotated so a chosen local axis (LookAtVector) points toward TargetPosition, optionally constrained to a cone angle and twisted to align with an up vector.
public	function	UKismetAnimationLibrary::K2_StartProfilingTimer	Starts a timer for measuring how long a section of an animation Blueprint graph takes to execute.
public	function	UKismetAnimationLibrary::K2_TwoBoneIK	Computes the joint and end positions for a two-bone IK chain (like an arm or leg) so it reaches toward an effector target, given an optional joint/pole target to control bend direction.

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?