1. Epic GamesDeveloper
  3. FScopedEvent

FScopedEvent

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

API > API/Runtime > API/Runtime/Core > API/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
Public function   Default constructor.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page