Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > HAL > FEvent

Light Theme

Dark Theme

FEvent

Interface for waitable events.

Windows

MacOS

Linux

Inheritance Hierarchy

FEvent

	FPThreadEvent
	FSingleThreadEvent

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/HAL/Event.h
Include	#include "HAL/Event.h"

Syntax

class FEvent

Remarks

Interface for waitable events.

This interface has platform-specific implementations that are used to wait for another thread to signal that it is ready for the waiting thread to do some work. It can also be used for telling groups of threads to exit.

Variables

		Name	Description
	uint32	EventId	An unique id of this event.
	TAtomic< uint32...	EventStartCycles	Greater than 0, if the event called wait.

Constructors

	Name	Description
	FEvent()	Default constructor.

Destructors

	Name	Description
	~FEvent()	Virtual destructor.

Functions

	Name	Description
void	AdvanceStats()	Advances stats associated with this event. Used to monitor wait->trigger history.
bool	Create ( bool bIsManualReset )	Creates the event.
bool	IsManualReset()	Whether the signaled state of this event needs to be reset manually.
void	Reset()	Resets the event to an untriggered (waitable) state.
void	ResetForStats()	Resets start cycles to 0.
void	Trigger()	Triggers the event so any waiting threads are activated.
void	TriggerForStats()	Send to the stats a special message which encodes a trigger for the event.
bool	Wait()	Waits an infinite amount of time for the event to be triggered.
bool	Wait ( uint32 WaitTime, const bool bIgnoreThreadIdleStats )	Waits the specified amount of time for the event to be triggered.
bool	Wait ( const FTimespan& WaitTime, const bool bIgnoreThreadIdleStats )	Waits the specified amount of time for the event to be triggered.
void	WaitForStats()	Sends to the stats a special messages which encodes a wait for the event.

Constants

Name	Description
EventUniqueId	Counter used to generate an unique id for the events.

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

Take our survey

Dismiss