1. Epic GamesDeveloper
  3. IAnimationBudgetAllocator

IAnimationBudgetAllocator

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

Unreal Engine C++ API Reference > Plugins > AnimationBudgetAllocator

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

  Type Name Description
Public function void Force component to tick this frame regardless of tick rate
Public function Static IAnimationBudgetAllocator *

Get ( UWorld* InWorld
)

 Get the budgeter for the specified world
Public function Const bool Get whether this budget allocator is enabled
Public function Const bool Get whether the specified component is set to tick or not
Public function void Register a component with the budgeter system.
Public function void

SetComponentSignificance ( USkeletalMeshComponentBudgeted* Component,
float Significance,
bool bNeverSkip,
bool bTickEvenIfNotRendered,
bool bAllowReducedWork,
bool bForceInterpolate
)

 Set the significance and other flags for the specified component.
Public function void

SetComponentTickEnabled ( USkeletalMeshComponentBudgeted* Component,
bool bShouldTick
)

 Set the specified component to tick or not.
Public function void

SetEnabled ( bool bInEnabled
)

 Set whether this budget allocator is enabled
Public function void

SetGameThreadLastCompletionTimeMs ( int32 InManagerHandle,
float InGameThreadLastCompletionTimeMs
)

 Set the completion task time
Public function void

SetGameThreadLastTickTimeMs ( int32 InManagerHandle,
float InGameThreadLastTickTimeMs
)

 Set the tick time
Public function void

SetIsRunningReducedWork ( USkeletalMeshComponentBudgeted* Component,
bool bInReducedWork
)

 Inform that we reduced work for a component
Public function void Set the various parameters
Public function void Unregister a component from the budgeter system.
Public function void

Update ( float DeltaSeconds
)

 Tick the system per-frame
Public function void Update the prerequisites of this component.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.