Navigation
API > API/Runtime > API/Runtime/Core
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. }
| Name | FScopedEvent |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/ScopedEvent.h |
| Include Path | #include "Misc/ScopedEvent.h" |
Syntax
class FScopedEvent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScopedEvent() |
Default constructor. | Misc/ScopedEvent.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FScopedEvent() |
Destructor. | Misc/ScopedEvent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Event | FEvent * | Holds the event. | Misc/ScopedEvent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEvent * Get() |
Retrieve the event, usually for passing around. | Misc/ScopedEvent.h | |
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 | Misc/ScopedEvent.h | |
void Trigger() |
Triggers the event. | Misc/ScopedEvent.h |