1. Epic GamesDeveloper
  3. IAnimationBudgetAllocator

IAnimationBudgetAllocator

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

API > API/Plugins > API/Plugins/AnimationBudgetAllocator

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

   
Name IAnimationBudgetAllocator
Type class
Header File /Engine/Plugins/Runtime/AnimationBudgetAllocator/Source/AnimationBudgetAllocator/Public/IAnimationBudgetAllocator.h
Include Path #include "IAnimationBudgetAllocator.h"

Syntax

class IAnimationBudgetAllocator

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForceNextTickThisFrame ( USkeletalMeshComponentBudgeted* Component
)

 Force component to tick this frame regardless of tick rate IAnimationBudgetAllocator.h  

bool GetEnabled()

 Get whether this budget allocator is enabled IAnimationBudgetAllocator.h  

bool IsComponentTickEnabled ( USkeletalMeshComponentBudgeted* Component
) const

 Get whether the specified component is set to tick or not IAnimationBudgetAllocator.h  
Register a component with the budgeter system. IAnimationBudgetAllocator.h  

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

 Set the significance and other flags for the specified component. IAnimationBudgetAllocator.h  

void SetComponentTickEnabled ( USkeletalMeshComponentBudgeted* Component,
bool bShouldTick
)

 Set the specified component to tick or not. IAnimationBudgetAllocator.h  

void SetEnabled ( bool bInEnabled
)

 Set whether this budget allocator is enabled IAnimationBudgetAllocator.h  

void SetGameThreadLastCompletionTimeMs ( int32 InManagerHandle,
float InGameThreadLastCompletionTimeMs
)

 Set the completion task time IAnimationBudgetAllocator.h  

void SetGameThreadLastTickTimeMs ( int32 InManagerHandle,
float InGameThreadLastTickTimeMs
)

 Set the tick time IAnimationBudgetAllocator.h  

void SetIsRunningReducedWork ( USkeletalMeshComponentBudgeted* Component,
bool bInReducedWork
)

 Inform that we reduced work for a component IAnimationBudgetAllocator.h  

void SetParameters ( const FAnimationBudgetAllocatorParameters& InParameters
)

 Set the various parameters IAnimationBudgetAllocator.h  

void UnregisterAllComponents()

 Calls UnregisterComponent on all components currently registered with the allocator. IAnimationBudgetAllocator.h  
Unregister a component from the budgeter system. IAnimationBudgetAllocator.h  

void Update ( float DeltaSeconds
)

 Tick the system per-frame IAnimationBudgetAllocator.h  
Update the prerequisites of this component. IAnimationBudgetAllocator.h  

Static

Name Remarks Include Path Unreal Specifiers

static IAnimationBudgetAllocator * Get ( UWorld* InWorld
)

 Get the budgeter for the specified world IAnimationBudgetAllocator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page