1. Epic GamesDeveloper
  3. TScriptSparseSet

TScriptSparseSet

Untyped set type for accessing [TSparseSet](API\Runtime\Core\TSparseSet) data, like [FScriptArray](API\Runtime\Core\FScriptArray) for [TArray](API\Runtime\Core\TArray).

API > API/Runtime > API/Runtime/Core

Untyped set type for accessing TSparseSet data, like FScriptArray for TArray. Must have the same memory representation as a TSparseSet.

   
Name TScriptSparseSet
Type class
Header File /Engine/Source/Runtime/Core/Public/Containers/ScriptSparseSet.h
Include Path #include "Containers/ScriptSparseSet.h"

Syntax

template<typename Allocator>  
class TScriptSparseSet

Constructors

Name Remarks Include Path Unreal Specifiers
  Containers/ScriptSparseSet.h  
  Containers/ScriptSparseSet.h  
These should really be private, because they shouldn't be called, but there's a bunch of code that needs to be fixed first. Containers/ScriptSparseSet.h  

Classes

Name Remarks
TrackedSparseArrayAllocator Encapsulates the allocators used by a sparse array in a single type.

Typedefs

Name Type Remarks Include Path
ElementArrayType TScriptSparseArray< TrackedSparseArrayAllocator >   Containers/ScriptSparseSet.h
HashAllocator typename Allocator::HashAllocator   Containers/ScriptSparseSet.h
HashType typename HashAllocator::template ForElementType< FSetElementId >   Containers/ScriptSparseSet.h
IntrusiveUnsetOptionalStateType TScriptSparseSet   Containers/ScriptSparseSet.h

Constants

Name Type Remarks Include Path
bHasIntrusiveUnsetOptionalState bool Start - intrusive TOptional state //. Containers/ScriptSparseSet.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Elements ElementArrayType   Containers/ScriptSparseSet.h  
Hash HashType   Containers/ScriptSparseSet.h  
HashSize int32   Containers/ScriptSparseSet.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( const void* Element,
const FScriptSparseSetLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> EqualityFn,
TFunctionRef< void(void*)> ConstructFn,
TFunctionRef< void(void*)> DestructFn
)

   Containers/ScriptSparseSet.h  

int32 AddUninitialized ( const FScriptSparseSetLayout& Layout
)

 Adds an uninitialized object to the set. Containers/ScriptSparseSet.h  

void CommitAllUninitialized ( const FScriptSparseSetLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash
)

   Containers/ScriptSparseSet.h  

void CommitLastUninitialized ( const FScriptSparseSetLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash
)

   Containers/ScriptSparseSet.h  

void Empty ( int32 Slack,
const FScriptSparseSetLayout& Layout
)

   Containers/ScriptSparseSet.h  

int32 FindIndex ( const void* Element,
const FScriptSparseSetLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> EqualityFn
) const

   Containers/ScriptSparseSet.h  

int32 FindIndexByHash ( const void* Element,
const FScriptSparseSetLayout& Layout,
uint32 KeyHash,
TFunctionRef< bool(const void*, const void*)> EqualityFn
) const

   Containers/ScriptSparseSet.h  

int32 FindOrAdd ( const void* Element,
const FScriptSparseSetLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> EqualityFn,
TFunctionRef< void(void*)> ConstructFn
)

   Containers/ScriptSparseSet.h  

const void * GetData ( int32 Index,
const FScriptSparseSetLayout& Layout
) const

   Containers/ScriptSparseSet.h  

void * GetData ( int32 Index,
const FScriptSparseSetLayout& Layout
)

   Containers/ScriptSparseSet.h  

int32 GetMaxIndex()

   Containers/ScriptSparseSet.h  

bool IsCompact()

   Containers/ScriptSparseSet.h  

bool IsEmpty()

   Containers/ScriptSparseSet.h  

bool IsValidIndex ( int32 Index
) const

 End - intrusive TOptional state //. Containers/ScriptSparseSet.h  

int32 Max()

   Containers/ScriptSparseSet.h  

void MoveAssign ( TScriptSparseSet& Other,
const FScriptSparseSetLayout& Layout
)

   Containers/ScriptSparseSet.h  

int32 Num()

   Containers/ScriptSparseSet.h  

int32 NumUnchecked()

   Containers/ScriptSparseSet.h  

void Rehash ( const FScriptSparseSetLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash
)

   Containers/ScriptSparseSet.h  

void RemoveAt ( int32 Index,
const FScriptSparseSetLayout& Layout
)

   Containers/ScriptSparseSet.h  

void RemoveAtUninitialized ( const FScriptSparseSetLayout& Layout,
int32 Index
)

   Containers/ScriptSparseSet.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CheckConstraints()

 This function isn't intended to be called, just to be compiled to validate the correctness of the type. Containers/ScriptSparseSet.h  

static int32 & GetHashIndexRef ( const void* Element,
const FScriptSparseSetLayout& Layout
)

   Containers/ScriptSparseSet.h  

static FSetElementId & GetHashNextIdRef ( const void* Element,
const FScriptSparseSetLayout& Layout
)

   Containers/ScriptSparseSet.h  

static FScriptSparseSetLayout GetScriptLayout ( int32 ElementSize,
int32 ElementAlignment
)

   Containers/ScriptSparseSet.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator= ( const TScriptSparseSet&
)

   Containers/ScriptSparseSet.h  

bool operator== ( FIntrusiveUnsetOptionalState Tag
) const

   Containers/ScriptSparseSet.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page