UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Mass::Private::TBitTypeRegistry< T, TUStructType > Struct Template Reference

#include <MassBitSetRegistry.h>

Classes

struct  FBitSetFactory
 
struct  FBitSetStructTracker
 

Public Types

using FBitSetBuilder = TTypeBitSetBuilder< T, TUStructType, TTypeBitSetTraits< T >::RequiresBaseType >
 
using FBitSet = typename FBitSetBuilder::FConstBitSet
 

Public Member Functions

 TBitTypeRegistry ()
 
FBitSetBuilder MakeBuilder (FBitSet &BitSet) const
 
FBitSetFactory MakeBuilder () const
 
int32 RegisterType (const UScriptStruct *Type)
 
template<typename TType >
int32 RegisterType ()
 

Public Attributes

FBitSetStructTracker StructTracker
 

Detailed Description

template<typename T, typename TUStructType = UScriptStruct>
struct UE::Mass::Private::TBitTypeRegistry< T, TUStructType >

Template class for registering and managing bitsets for Mass types (e.g., Fragments and Tags). Provides functionality to create builders for constructing bitsets. The type hosts a FStructTracker instance that stores information on all the types used to build bitsets via it, and only those types - as opposed to TStructTypeBitSet, which is using the same FStructTracker throughout the engine's instance lifetime.

Parameters
Tthe base Mass type (e.g., FMassFragment or FMassTag).
TUStructTypethe Unreal Engine struct type, default is UScriptStruct.

Member Typedef Documentation

◆ FBitSet

The type representing the runtime-used bitset. Const by design.

◆ FBitSetBuilder

template<typename T , typename TUStructType = UScriptStruct>
using UE::Mass::Private::TBitTypeRegistry< T, TUStructType >::FBitSetBuilder = TTypeBitSetBuilder<T, TUStructType, TTypeBitSetTraits<T>::RequiresBaseType>

Alias for the bitset builder specific to the type T

Constructor & Destructor Documentation

◆ TBitTypeRegistry()

MASSENTITY_API UE::Mass::FTagBitRegistry::TBitTypeRegistry ( )
inline

Constructor that initializes the struct tracker. Uses a lambda to retrieve the UStruct representing the base type T.

Explicit template instantiation declarations for the registries

Member Function Documentation

◆ MakeBuilder() [1/2]

template<typename T , typename TUStructType = UScriptStruct>
FBitSetFactory UE::Mass::Private::TBitTypeRegistry< T, TUStructType >::MakeBuilder ( ) const
inline

Creates a factory for building new bitsets, essentially a FBitSetBuilder-BitSet combo.

Returns
A new FBitSetFactory instance.

◆ MakeBuilder() [2/2]

template<typename T , typename TUStructType = UScriptStruct>
FBitSetBuilder UE::Mass::Private::TBitTypeRegistry< T, TUStructType >::MakeBuilder ( FBitSet BitSet) const
inline

Creates a bitset builder for an existing bitset.

Parameters
BitSetthe bitset instance to modify
Returns
A new FBitSetBuilder instance

◆ RegisterType() [1/2]

template<typename T , typename TUStructType = UScriptStruct>
template<typename TType >
int32 UE::Mass::Private::TBitTypeRegistry< T, TUStructType >::RegisterType ( )
inline

Template method to register a type with the struct tracker.

Parameters
TTypethe type to register.
Returns
The index assigned to the registered type.

◆ RegisterType() [2/2]

template<typename T , typename TUStructType = UScriptStruct>
int32 UE::Mass::Private::TBitTypeRegistry< T, TUStructType >::RegisterType ( const UScriptStruct Type)
inline

Registers a type with the struct tracker.

Parameters
Typethe UScriptStruct representing the type to register.
Returns
The index assigned to the registered type.

Member Data Documentation

◆ StructTracker

template<typename T , typename TUStructType = UScriptStruct>
FBitSetStructTracker UE::Mass::Private::TBitTypeRegistry< T, TUStructType >::StructTracker
mutable

Struct tracker for managing types


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