Apparatus Version 1.8
ECS data-oriented workflow for Unreal Engine.
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
FDetailInfo Struct Reference

The internal information about a detail. More...

#include <DetailInfo.h>

Collaboration diagram for FDetailInfo:
Collaboration graph
[legend]

Public Types

enum  { InvalidId = -1 , FirstId = 0 }
 

Public Member Functions

 FDetailInfo ()
 Construct a stale detail information struct. More...
 
 FDetailInfo (const TSubclassOf< UDetail > InClass, const int32 InId)
 Construct a new detail information struct. More...
 

Public Attributes

TSubclassOf< UDetailClass = nullptr
 The class of the detail. More...
 
int32 Id = InvalidId
 The unique identifier of the detail. More...
 
FBitMask Mask
 The bitmask of the detail. More...
 
FBitMask ExcludedMask
 The excluded bitmask of the detail. More...
 

Friends

template<typename ChunkItT , typename BeltItT >
struct TChain
 
struct FSubjectHandle
 
class UChunk
 
class UMachine
 
class ISubjective
 

Detailed Description

The internal information about a detail.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
InvalidId 

Invalid detail identifier.

FirstId 

First valid detail identifier.

Constructor & Destructor Documentation

◆ FDetailInfo() [1/2]

FDetailInfo::FDetailInfo ( )
inline

Construct a stale detail information struct.

◆ FDetailInfo() [2/2]

FDetailInfo::FDetailInfo ( const TSubclassOf< UDetail InClass,
const int32  InId 
)
inline

Construct a new detail information struct.

Friends And Related Function Documentation

◆ FSubjectHandle

friend struct FSubjectHandle
friend

◆ ISubjective

friend class ISubjective
friend

◆ TChain

template<typename ChunkItT , typename BeltItT >
friend struct TChain
friend

◆ UChunk

friend class UChunk
friend

◆ UMachine

friend class UMachine
friend

Member Data Documentation

◆ Class

TSubclassOf<UDetail> FDetailInfo::Class = nullptr

The class of the detail.

This is a strong pointer that should grab and hold the class, so that non-property detail references in detailmarks are guaranteed to be present.

◆ ExcludedMask

FBitMask FDetailInfo::ExcludedMask

The excluded bitmask of the detail.

◆ Id

int32 FDetailInfo::Id = InvalidId

The unique identifier of the detail.

Matches its index within the global machine's array.

◆ Mask

FBitMask FDetailInfo::Mask

The bitmask of the detail.


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