Navigation
API > API/Plugins > API/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 | |
|---|---|---|---|
| IAnimationBudgetAllocator * | Get the budgeter for the specified world | ||
| bool | GetEnabled () |
Get whether this budget allocator is enabled | |
| bool | IsComponentTickEnabled
(
USkeletalMeshComponentBudgeted* Component |
Get whether the specified component is set to tick or not | |
| void | RegisterComponent
(
USkeletalMeshComponentBudgeted* InComponent |
Register a component with the budgeter system. | |
| void | SetComponentSignificance
(
USkeletalMeshComponentBudgeted* Component, |
Set the significance and other flags for the specified component. | |
| void | SetComponentTickEnabled
(
USkeletalMeshComponentBudgeted* Component, |
Set the specified component to tick or not. | |
| void | SetEnabled
(
bool bInEnabled |
Set whether this budget allocator is enabled | |
| void | SetGameThreadLastCompletionTimeMs
(
int32 InManagerHandle, |
Set the completion task time | |
| void | SetGameThreadLastTickTimeMs
(
int32 InManagerHandle, |
Set the tick time | |
| void | SetIsRunningReducedWork
(
USkeletalMeshComponentBudgeted* Component, |
Inform that we reduced work for a component | |
| void | SetParameters
(
const FAnimationBudgetAllocatorParameters& InParameters |
Set the various parameters | |
| void | UnregisterComponent
(
USkeletalMeshComponentBudgeted* InComponent |
Unregister a component from the budgeter system. | |
| void | Update
(
float DeltaSeconds |
Tick the system per-frame | |
| void | UpdateComponentTickPrerequsites
(
USkeletalMeshComponentBudgeted* InComponent |
Update the prerequisites of this component. |