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

#include <MassArchetypeGroup.h>

Public Member Functions

 FArchetypeGroups ()=default
 
 FArchetypeGroups (const FArchetypeGroups &InGroups)=default
 
 FArchetypeGroups (FArchetypeGroups &&InGroups)=default
 
bool operator== (const FArchetypeGroups &OtherGroups) const
 
FArchetypeGroupsoperator= (FArchetypeGroups &&InGroups)
 
FArchetypeGroupsoperator= (const FArchetypeGroups &InGroups)
 
void Add (FArchetypeGroupHandle GroupHandle)
 
FArchetypeGroups Add (FArchetypeGroupHandle GroupHandle) const
 
void Remove (FArchetypeGroupType GroupType)
 
FArchetypeGroups Remove (FArchetypeGroupType GroupType) const
 
void Shrink ()
 
bool IsShrunk () const
 
FArchetypeGroupID GetID (const FArchetypeGroupType GroupType) const
 
bool ContainsType (const FArchetypeGroupType GroupType) const
 

Protected Attributes

TSparseArray< FArchetypeGroupIDIDContainer
 

Friends

uint32 GetTypeHash (const FArchetypeGroups &Instance)
 

Constructor & Destructor Documentation

◆ FArchetypeGroups() [1/3]

UE::Mass::FArchetypeGroups::FArchetypeGroups ( )
default

◆ FArchetypeGroups() [2/3]

UE::Mass::FArchetypeGroups::FArchetypeGroups ( const FArchetypeGroups InGroups)
default

◆ FArchetypeGroups() [3/3]

UE::Mass::FArchetypeGroups::FArchetypeGroups ( FArchetypeGroups &&  InGroups)
default

Member Function Documentation

◆ Add() [1/2]

void UE::Mass::FArchetypeGroups::Add ( FArchetypeGroupHandle  GroupHandle)

Adds or updates the given (GroupType, GroupID) combination to IDContainer

◆ Add() [2/2]

FArchetypeGroups UE::Mass::FArchetypeGroups::Add ( FArchetypeGroupHandle  GroupHandle) const

Adds or updates the given (GroupType, GroupID) combination to IDContainer

Returns
a copy of this FArchetypeGroups container with GroupHandle added to the ID container
Note
using [[nodiscard]] to avoid accidental calls on const instances that would not produce any effects

◆ ContainsType()

bool UE::Mass::FArchetypeGroups::ContainsType ( const FArchetypeGroupType  GroupType) const
inline

◆ GetID()

FArchetypeGroupID UE::Mass::FArchetypeGroups::GetID ( const FArchetypeGroupType  GroupType) const
inline

◆ IsShrunk()

bool UE::Mass::FArchetypeGroups::IsShrunk ( ) const

◆ operator=() [1/2]

FArchetypeGroups & UE::Mass::FArchetypeGroups::operator= ( const FArchetypeGroups InGroups)

◆ operator=() [2/2]

FArchetypeGroups & UE::Mass::FArchetypeGroups::operator= ( FArchetypeGroups &&  InGroups)

◆ operator==()

bool UE::Mass::FArchetypeGroups::operator== ( const FArchetypeGroups OtherGroups) const

◆ Remove() [1/2]

void UE::Mass::FArchetypeGroups::Remove ( FArchetypeGroupType  GroupType)

Removes the stored GroupID associated with the given GroupType. If the given group type is not stored in IDContainer the request is ignored.

◆ Remove() [2/2]

FArchetypeGroups UE::Mass::FArchetypeGroups::Remove ( FArchetypeGroupType  GroupType) const

Removes the stored GroupID associated with the given GroupType. If the given group type is not stored in IDContainer the request is ignored.

Returns
a copy of this FArchetypeGroups container with GroupType removed.
Note
using [[nodiscard]] to avoid accidental calls on const instances that would not produce any effects

◆ Shrink()

void UE::Mass::FArchetypeGroups::Shrink ( )

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FArchetypeGroups Instance)
friend

Member Data Documentation

◆ IDContainer

TSparseArray<FArchetypeGroupID> UE::Mass::FArchetypeGroups::IDContainer
protected

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