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

Public function Static

IAnimationBu ...

 

Get

(
    UWorld * InWorld
)

Get the budgeter for the specified world

Public function Const

bool

 

GetEnabled()

Get whether this budget allocator is enabled

Public function Const

bool

 

IsComponentTickEnabled

Get whether the specified component is set to tick or not

Public function

void

 

RegisterComponent

Register a component with the budgeter system.

Public function

void

 

SetComponentSignificance

(
    USkeletalMeshComponentBudgeted *...,
    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 *...,
    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 InGameThreadLastCompletionTim...
)

Set the completion task time

Public function

void

 

SetGameThreadLastTickTimeMs

(
    int32 InManagerHandle,
    float InGameThreadLastTickTimeMs
)

Set the tick time

Public function

void

 

SetIsRunningReducedWork

(
    USkeletalMeshComponentBudgeted *...,
    bool bInReducedWork
)

Inform that we reduced work for a component

Public function

void

 

SetParameters

(
    const FAnimationBudgetAllocatorPara ...
)

Set the various parameters

Public function

void

 

UnregisterComponent

Unregister a component from the budgeter system.

Public function

void

 

Update

(
    float DeltaSeconds
)

Tick the system per-frame

Public function

void

 

UpdateComponentTickPrerequsites

Update the prerequisites of this component.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback