FScopedEvent

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

Windows
MacOS
Linux

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

Name Description

Public function

FScopedEvent()

Default constructor.

Destructors

Name Description

Public function

~FScopedEvent()

Destructor.

Functions

Name Description

Public function

FEvent *

 

Get()

Retrieve the event, usually for passing around.

Public function

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

Public function

void

 

Trigger()

Triggers the event.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss