UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Mass::FScopedEntityBuilder Struct Reference

#include <MassEntityBuilder.h>

+ Inheritance diagram for UE::Mass::FScopedEntityBuilder:

Public Member Functions

 UE_NONCOPYABLE (FScopedEntityBuilder)
 
template<typename... TArgs>
 FScopedEntityBuilder (TArgs &&... InArgs)
 
 ~FScopedEntityBuilder ()
 
- Public Member Functions inherited from UE::Mass::FEntityBuilder
UE_API FEntityBuilder (FMassEntityManager &InEntityManager)
 
UE_API FEntityBuilder (const TSharedRef< FMassEntityManager > &InEntityManager)
 
UE_API FEntityBuilder (const FEntityBuilder &Other)
 
UE_API FEntityBuilderoperator= (const FEntityBuilder &Other)
 
UE_API FEntityBuilderoperator= (FEntityBuilder &&Other)
 
UE_API ~FEntityBuilder ()
 
UE_API FMassEntityHandle Commit ()
 
UE_API FMassEntityHandle CommitAndReprepare ()
 
UE_API void Reprepare ()
 
UE_API void Reset (const bool bReleaseEntityHandleIfReserved=true)
 
UE_API bool SetReservedEntityHandle (const FMassEntityHandle ReservedEntityHandle)
 
UE_API bool AppendDataFromEntity (const FMassEntityHandle SourceEntityHandle)
 
UE_API bool CopyDataFromEntity (const FMassEntityHandle SourceEntityHandle)
 
template<typename T , typename... TArgs>
requires (CElement<T> && !(CTag<T> || CChunkFragment<T>))
T & Add_GetRef (TArgs &&... InArgs)
 
template<typename T , typename... TArgs>
requires (CElement<T> && !(CTag<T> || CChunkFragment<T>))
T & GetOrCreate (TArgs &&... InArgs)
 
template<CTag T>
FEntityBuilderAdd ()
 
template<CChunkFragment T>
FEntityBuilderAdd ()
 
template<typename T , typename... TArgs>
requires (CElement<T> && !(CTag<T> || CChunkFragment<T>))
FEntityBuilderAdd (TArgs &&... InArgs)
 
UE_API FEntityBuilderAdd (const FInstancedStruct &ElementInstance)
 
UE_API FEntityBuilderAdd (FInstancedStruct &&ElementInstance)
 
UE_API FEntityBuilderAdd (TNotNull< const UScriptStruct * > ElementType)
 
UE_API FEntityBuilderAddRelation (UE::Mass::FTypeHandle RelationTypeHandle, FMassEntityHandle OtherEntity, Relations::ERelationRole InputEntityRole=Relations::ERelationRole::Object)
 
template<UE::Mass::CRelation T>
FEntityBuilderAddRelation (FMassEntityHandle OtherEntity, Relations::ERelationRole InputEntityRole=Relations::ERelationRole::Object)
 
UE_API void ForEachRelation (const TFunctionRef< bool(FPendingRelationParams &)> &Operator)
 
template<typename T >
requires (CElement<T> && !(CTag<T> || CChunkFragment<T>))
T * Find ()
 
void ConfigureArchetypeCreation (const FMassArchetypeCreationParams &InCreationParams)
 
UE_API FMassEntityHandle GetEntityHandle () const
 
UE_API FMassArchetypeHandle GetArchetypeHandle ()
 
bool IsValid () const
 
bool HasReservedEntityHandle () const
 
bool IsCommitted () const
 
TSharedRef< FMassEntityManagerGetEntityManager ()
 

Additional Inherited Members

- Static Public Member Functions inherited from UE::Mass::FEntityBuilder
static UE_API FEntityBuilder Make (const TSharedRef< FMassEntityManager > &InEntityManager, const FMassArchetypeCompositionDescriptor &Composition, TConstArrayView< FInstancedStruct > InitialFragmentValues={}, TConstArrayView< FConstSharedStruct > ConstSharedFragments={}, TConstArrayView< FSharedStruct > SharedFragments={})
 
static UE_API FEntityBuilder Make (const TSharedRef< FMassEntityManager > &InEntityManager, const FMassArchetypeCompositionDescriptor &Composition, TArray< FInstancedStruct > &&InitialFragmentValues, TArray< FConstSharedStruct > &&ConstSharedFragments, TArray< FSharedStruct > &&SharedFragments)
 
- Protected Member Functions inherited from UE::Mass::FEntityBuilder
UE_API void CacheSharedFragmentValue ()
 
UE_API void CacheArchetypeHandle ()
 
UE_API void InvalidateCachedData ()
 

Constructor & Destructor Documentation

◆ FScopedEntityBuilder()

template<typename... TArgs>
UE::Mass::FScopedEntityBuilder::FScopedEntityBuilder ( TArgs &&...  InArgs)
inline

◆ ~FScopedEntityBuilder()

UE::Mass::FScopedEntityBuilder::~FScopedEntityBuilder ( )
inline

Member Function Documentation

◆ UE_NONCOPYABLE()

UE::Mass::FScopedEntityBuilder::UE_NONCOPYABLE ( FScopedEntityBuilder  )

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