FScopedEvent | Unreal Engine 4.27 Documentation

Unreal Engine C++ API Reference > Runtime > Core > Misc

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/ScopedEvent.h
Include	#include "Misc/ScopedEvent.h"

Syntax

class FScopedEvent

Remarks

This class is allows a simple one-shot scoped event.

Usage: { FScopedEvent MyEvent; SendReferenceOrPointerToSomeOtherThread(&MyEvent); // Other thread calls MyEvent->Trigger(); // MyEvent destructor is here, we wait here. }

Constructors

	Type	Name	Description
		FScopedEvent ()	Default constructor.

Destructors

	Type	Name	Description
		~FScopedEvent ()	Destructor.

Functions

Type	Name	Description
FEvent *	Get ()	Retrieve the event, usually for passing around.
bool	IsReady ()	Checks if the event has been triggered (used for special early out cases of scope event) if this returns true once it will return true forever
void	Trigger ()	Triggers the event.