Break AnimationBudgetAllocatorParameters

Break AnimationBudgetAllocatorParameters

Windows
MacOS
Linux

Adds a node that breaks a 'AnimationBudgetAllocatorParameters' into its member fields

Break AnimationBudgetAllocatorParameters
Animation Budget Allocator Parameters
Budget In Ms
0.0
Min Quality
0.0
Max Tick Rate
0
Work Unit Smoothing Speed
0.0
Always Tick Falloff Aggression
0.0
Interpolation Falloff Aggression
0.0
Interpolation Max Rate
0
Max Interpolated Components
0
Interpolation Tick Multiplier
0.0
Initial Estimated Work Unit Time Ms
0.0
Max Ticked Offsreen Components
0
State Change Throttle In Frames
0
Budget Factor Before Reduced Work
0.0
Budget Factor Before Reduced Work Epsilon
0.0
Budget Pressure Smoothing Speed
0.0
Reduced Work Throttle Min In Frames
0
Reduced Work Throttle Max In Frames
0
Budget Factor Before Aggressive Reduced Work
0.0
Reduced Work Throttle Max Per Frame
0
Budget Pressure Before Emergency Reduced Work
0.0

Inputs

Animation Budget Allocator Parameters
Animation Budget Allocator Parameters Structure (by ref)

Outputs

Budget In Ms
Float

Values > 0.1. The time in milliseconds that we allocate for skeletal mesh work to be performed. When overbudget various other parameters come into play, such as AlwaysTickFalloffAggression and InterpolationFalloffAggression.

Min Quality
Float

Values [0.0, 1.0]. The minimum quality metric allowed. Quality is determined simply by NumComponentsTickingThisFrame / NumComponentsThatWeNeedToTick. If this is anything other than 0.0 then we can potentially go over our time budget.

Max Tick Rate
Integer

Values >= 1. The maximum tick rate we allow. If this is set then we can potentially go over budget, but keep quality of individual meshes to a reasonable level.

Work Unit Smoothing Speed
Float

Values > 0.1. The speed at which the average work unit converges on the measured amount.

Always Tick Falloff Aggression
Float

Range [0.1, 0.9]. Controls the rate at which 'always ticked' components falloff under load. Higher values mean that we reduce the number of always ticking components by a larger amount when the allocated time budget is exceeded.

Interpolation Falloff Aggression
Float

Range [0.1, 0.9]. Controls the rate at which interpolated components falloff under load. Higher values mean that we reduce the number of interpolated components by a larger amount when the allocated time budget is exceeded. Components are only interpolated when the time budget is exceeded.

Interpolation Max Rate
Integer

Values > 1. Controls the rate at which ticks happen when interpolating.

Max Interpolated Components
Integer

Range >= 0. Max number of components to interpolate before we start throttling.

Interpolation Tick Multiplier
Float

Range [0.1, 0.9]. Controls the expected value an amortized interpolated tick will take compared to a 'normal' tick.

Initial Estimated Work Unit Time Ms
Float

Values > 0.0. Controls the time in milliseconds we expect, on average, for a skeletal mesh component to execute. The value only applies for the first tick of a component, after which we use the real time the tick takes.

Max Ticked Offsreen Components
Integer

Values >= 1 The maximum number of offscreen components we tick (most significant first)

State Change Throttle In Frames
Integer

Range [1, 128] Prevents throttle values from changing too often due to system and load noise.

Budget Factor Before Reduced Work
Float

Range > 1 Reduced work will be delayed until budget pressure goes over this amount.

Budget Factor Before Reduced Work Epsilon
Float

Range > 0.0. Increased work will be delayed until budget pressure goes under BudgetFactorBeforeReducedWork minus this amount.

Budget Pressure Smoothing Speed
Float

Range > 0.0. How much to smooth the budget pressure value used to throttle reduced work.

Reduced Work Throttle Min In Frames
Integer

Range [1, 255]. Prevents reduced work from changing too often due to system and load noise. Min value used when over budget pressure (i.e. aggressive reduction).

Reduced Work Throttle Max In Frames
Integer

Range [1, 255]. Prevents reduced work from changing too often due to system and load noise. Max value used when under budget pressure.

Budget Factor Before Aggressive Reduced Work
Float

Range > 1. Reduced work will be applied more rapidly when budget pressure goes over this amount.

Reduced Work Throttle Max Per Frame
Integer

Range [1, 255]. Controls the max number of components that are switched to/from reduced work per tick.

Budget Pressure Before Emergency Reduced Work
Float

Range > 0.0. Controls the budget pressure where emergency reduced work (applied to all components except those that are bAlwaysTick).

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