UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FScriptTimeLimiter Class Reference

#include <ScriptTimeLimiter.h>

Public Member Functions

 FScriptTimeLimiter ()=default
 
COREUOBJECT_API void StartTimer ()
 
COREUOBJECT_API void StopTimer ()
 
COREUOBJECT_API bool HasExceededTimeLimit ()
 
COREUOBJECT_API bool HasExceededTimeLimit (double TimeLimit)
 

Static Public Member Functions

static COREUOBJECT_API FScriptTimeLimiterGet ()
 

Constructor & Destructor Documentation

◆ FScriptTimeLimiter()

UE::FScriptTimeLimiter::FScriptTimeLimiter ( )
default

Member Function Documentation

◆ Get()

UE::FScriptTimeLimiter & UE::FScriptTimeLimiter::Get ( )
static
Returns
Reference to the thread-local singleton ScriptTimeLimiter

◆ HasExceededTimeLimit() [1/2]

bool UE::FScriptTimeLimiter::HasExceededTimeLimit ( )

Returns true if the timer has been running longer than the Verse computation limit. False is always returned if the timer is not running.

◆ HasExceededTimeLimit() [2/2]

bool UE::FScriptTimeLimiter::HasExceededTimeLimit ( double  TimeLimit)

Returns true if the timer has been running longer than the passed-in time limit. False is always returned if the timer is not running.

◆ StartTimer()

void UE::FScriptTimeLimiter::StartTimer ( )

The timer is started when the first (outermost) call to StartTimer occurs. Nesting calls is allowed, but will not grant additional computation time past the limit.

◆ StopTimer()

void UE::FScriptTimeLimiter::StopTimer ( )

The timer is stopped when every call to StartTimer has had a matching StopTimer call. At this point, the time limit is reset.


The documentation for this class was generated from the following files: