Apparatus Version 1.21
ECS data-oriented workflow for Unreal Engine.
Macros | Typedefs | Enumerations | Functions
BootFilter.h File Reference
#include "CoreMinimal.h"
#include "UObject/Class.h"
#include "Flagmark.h"
#include "BootFilter.generated.h"
Include dependency graph for BootFilter.h:
This graph shows which files directly or indirectly include this file:

Macros

#define SKIP_MACHINE_H
 
#define BOOT_FILTER_H_SKIPPED_MACHINE_H
 

Typedefs

using EBootState = EBootFilter
 The state of booting. More...
 

Enumerations

enum class  EBootFilter : uint8 { None = 0x0 UMETA(DisplayName = "None") , Booted = 1 << 0 UMETA(DisplayName = "Booted") , Halted = 1 << 1 UMETA(DisplayName = "Halted") , All = Booted | Halted UMETA(DisplayName = "Booted + Halted") }
 The boot filter specification. More...
 

Functions

uint32 GetTypeHash (const UClass *InClass)
 Hash the class. More...
 
uint32 GetTypeHash (const EBootFilter &BootFilter)
 Hash the boot filter. More...
 
APPARATUSRUNTIME_API UEnum * GetBootFilterClass ()
 Get the boot filter class. More...
 
EBootFilter BootFilterFromState (const bool bState)
 Convert a boolean booted state to a filter (state). More...
 
FString BootFilterToString (const EBootFilter BootFilter)
 Convert a boot filter variable to a string. More...
 
FArchive & operator<< (FArchive &Archive, EBootFilter &BootFilter)
 Serialize a boot filter to an archive. More...
 
EFlagmark ToFlagmark (const EBootFilter &BootFilter)
 Convert a boot filter to a flagmark state. More...
 
EBootState ToBootState (const EFlagmark Flagmark)
 Convert a flagmark to a boot state. More...
 

Macro Definition Documentation

◆ BOOT_FILTER_H_SKIPPED_MACHINE_H

#define BOOT_FILTER_H_SKIPPED_MACHINE_H

◆ SKIP_MACHINE_H

#define SKIP_MACHINE_H

Typedef Documentation

◆ EBootState

The state of booting.

A synonym to EBootFilter

Enumeration Type Documentation

◆ EBootFilter

enum class EBootFilter : uint8
strong

The boot filter specification.

Deprecated as of 1.10. Do not use it, please.

Enumerator
None 

A filter matching nothing.

Booted 

A filter matching only the booted subjects.

Halted 

A filter matching only the not-yet-booted subjects.

All 

A filter matching both booted and not booted subjects.

Function Documentation

◆ BootFilterFromState()

EBootFilter BootFilterFromState ( const bool  bState)
inline

Convert a boolean booted state to a filter (state).

Parameters
bStateThe state of being booted.

◆ BootFilterToString()

FString BootFilterToString ( const EBootFilter  BootFilter)
inline

Convert a boot filter variable to a string.

◆ GetBootFilterClass()

APPARATUSRUNTIME_API UEnum * GetBootFilterClass ( )
inline

Get the boot filter class.

◆ GetTypeHash() [1/2]

uint32 GetTypeHash ( const EBootFilter BootFilter)
inline

Hash the boot filter.

◆ GetTypeHash() [2/2]

uint32 GetTypeHash ( const UClass *  InClass)
inline

Hash the class.

◆ operator<<()

FArchive & operator<< ( FArchive &  Archive,
EBootFilter BootFilter 
)
inline

Serialize a boot filter to an archive.

◆ ToBootState()

EBootState ToBootState ( const EFlagmark  Flagmark)
inline

Convert a flagmark to a boot state.

◆ ToFlagmark()

EFlagmark ToFlagmark ( const EBootFilter BootFilter)
inline

Convert a boot filter to a flagmark state.