FSingleThreadEvent::Wait

Waits the specified amount of time for the event to be triggered.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

FEvent::Wait()

FSingleThreadEvent::Wait()

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/SingleThreadEvent.h

Include

#include "Misc/SingleThreadEvent.h"

Syntax

virtual bool Wait
(
    uint32 WaitTime,
    const bool bIgnoreThreadIdleStats
)

Remarks

Waits the specified amount of time for the event to be triggered.

A wait time of MAX_uint32 is treated as infinite wait.

Returns

true if the event was triggered, false if the wait timed out.

Parameters

Parameter

Description

WaitTime

The time to wait (in milliseconds).

bIgnoreThreadIdleStats

If true, ignores ThreadIdleStats