Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > AnimationBudgetAllocator > IAnimationBudgetAllocator

Light Theme

Dark Theme

IAnimationBudgetAllocator

Dynamically manages skeletal mesh component tick rates to try to maintain a specified budget.

Windows

MacOS

Linux

References

Module	AnimationBudgetAllocator
Header	/Engine/Plugins/Runtime/AnimationBudgetAllocator/Source/AnimationBudgetAllocator/Public/IAnimationBudgetAllocator.h
Include	#include "IAnimationBudgetAllocator.h"

Syntax

class IAnimationBudgetAllocator

Remarks

Dynamically manages skeletal mesh component tick rates to try to maintain a specified budget.

Functions

	Name	Description
IAnimationBu...	Get ( UWorld* InWorld )	Get the budgeter for the specified world
bool	GetEnabled()	Get whether this budget allocator is enabled
bool	IsComponentTickEnabled ( USkeletalMeshComponentBudgeted*... )	Get whether the specified component is set to tick or not
void	RegisterComponent ( USkeletalMeshComponentBudgeted*... )	Register a component with the budgeter system.
void	SetComponentSignificance ( USkeletalMeshComponentBudgeted*..., float Significance, bool bNeverSkip, bool bTickEvenIfNotRendered, bool bAllowReducedWork, bool bForceInterpolate )	Set the significance and other flags for the specified component.
void	SetComponentTickEnabled ( USkeletalMeshComponentBudgeted*..., bool bShouldTick )	Set the specified component to tick or not.
void	SetEnabled ( bool bInEnabled )	Set whether this budget allocator is enabled
void	SetGameThreadLastCompletionTimeMs ( int32 InManagerHandle, float InGameThreadLastCompletionTim... )	Set the completion task time
void	SetGameThreadLastTickTimeMs ( int32 InManagerHandle, float InGameThreadLastTickTimeMs )	Set the tick time
void	SetIsRunningReducedWork ( USkeletalMeshComponentBudgeted*..., bool bInReducedWork )	Inform that we reduced work for a component
void	SetParameters ( const FAnimationBudgetAllocatorPara... )	Set the various parameters
void	UnregisterComponent ( USkeletalMeshComponentBudgeted*... )	Unregister a component from the budgeter system.
void	Update ( float DeltaSeconds )	Tick the system per-frame
void	UpdateComponentTickPrerequsites ( USkeletalMeshComponentBudgeted*... )	Update the prerequisites of this component.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss