SetBackgroundThrottle

Turn the editor's background throttle ("Use Less CPU when in Background") on or off, in memory only.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Editor")
static bool SetBackgroundThrottle(bool bThrottle);

Blueprint Set Background Throttle

The graph as text

Set Background Throttle (function call)
- In Throttle (Boolean): false
- Out Return Value (Boolean): not connected

Header: #include "OrreryTerrainEditorLibrary.h"
Module: PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability: Stable: changes within a major version only add.
Thread: Game thread, editor only. (the rule of UOrreryTerrainEditorLibrary)
Blueprint: Set Background Throttle, in Orrery › Terrain › Editor

Description

Captures turn it off: on, an editor without focus draws its viewports only when a shot draws them, and work that advances per rendered frame (virtual texture pages, TSR history) stalls between shots.

Parameters

Name	Type	Default	Meaning
`bThrottle`	`bool`	—	—

Returns

Whether it was on.