Apparatus Version 1.2.0
ECS data-driven workflow for Unreal Engine.
Public Member Functions | List of all members
FApparatusStatusThreadState Struct Reference

The local state of a status on the thread. More...

#include <ApparatusStatus.h>

Public Member Functions

EApparatusStatus Set (EApparatusStatus Status)
 Set the current status. More...
 
void Reset ()
 Reset the status, clearing all of the errors also. More...
 
bool HasErrors () const
 Check if there are any errors currently queued. More...
 
EApparatusStatus PopError ()
 Pop the first queued error status (if any) and return it. More...
 
EApparatusStatus GetLastError () const
 Peek the last error from the queue, without removing it. More...
 

Detailed Description

The local state of a status on the thread.

Member Function Documentation

◆ GetLastError()

EApparatusStatus FApparatusStatusThreadState::GetLastError ( ) const
inline

Peek the last error from the queue, without removing it.

Otherwise, returns EApparatusStatus::None.

Returns
The last error set in the queue or EApparatusStatus::None, if there are no errors currently queued.

◆ HasErrors()

bool FApparatusStatusThreadState::HasErrors ( ) const
inline

Check if there are any errors currently queued.

◆ PopError()

EApparatusStatus FApparatusStatusThreadState::PopError ( )
inline

Pop the first queued error status (if any) and return it.

Returns
The last error or EApparatusStatus::Success

◆ Reset()

void FApparatusStatusThreadState::Reset ( )
inline

Reset the status, clearing all of the errors also.

◆ Set()

EApparatusStatus FApparatusStatusThreadState::Set ( EApparatusStatus  Status)
inline

Set the current status.

Parameters
StatusThe new status to set.
Returns
The former status.

The documentation for this struct was generated from the following file: