Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > UObject > FScriptSetHelper

Light Theme

Dark Theme

FScriptSetHelper

[FScriptSetHelper](API\Runtime\CoreUObject\UObject\FScriptSetHelper): Pseudo dynamic Set.

Windows

MacOS

Linux

Inheritance Hierarchy

FScriptSetHelper

FScriptSetHelper_InContainer

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h
Include	#include "UObject/UnrealType.h"

Syntax

class FScriptSetHelper

Remarks

FScriptSetHelper: Pseudo dynamic Set. Used to work with Set properties in a sensible way.

Variables

		Name	Description
	FProperty *	ElementProp
	FScriptSet *...	Set
	FScriptSetLayou...	SetLayout

Constructors

	Name	Description
	FScriptSetHelper ( const FSetProperty* InProperty, const void* InSet )	Constructor, brings together a property and an instance of the property located in memory

Functions

	Name	Description
int32	AddDefaultValue_Invalid_NeedsRehash()	Adds a blank, constructed value to a given size.
void	AddElement ( const void* ElementToAdd )	Adds the element to the set, returning true if the element was added, or false if the element was already present
int32	AddUninitializedValue()	Add an uninitialized value to the end of the set.
FScriptSetHe...	CreateHelperFormElementProperty ( FProperty* InElementProperty, const void* InSet )
FScriptSetHe...	CreateIterator()
void	EmptyElements ( int32 Slack )	Remove all values from the set, calling destructors, etc as appropriate.
int32	FindElementIndex ( const void* ElementToFind, int32 IndexHint )	Finds the index of an element in a set
int32	FindElementIndexFromHash ( const void* ElementToFind )	Finds element index from hash, rather than linearly searching
uint8 *	FindElementPtr ( const void* ElementToFind, int32 IndexHint )	Finds the pair in a map which matches the key in another pair.
uint8 *	FindElementPtrFromHash ( const void* ElementToFind )	Finds element pointer from hash, rather than linearly searching
int32	FindInternalIndex ( int32 LogicalIdx )	Maps have gaps in their indices, so this function translates a logical index (ie. Nth element) to an internal index that can be used for the other functions in this class.
FProperty &#...	GetElementProperty()	Returns the property representing the element of the set
uint8 *	GetElementPtr ( int32 Index )	Returns a uint8 pointer to the element in the set.
const uint8 ...	GetElementPtr ( int32 Index )	Returns a uint8 pointer to the element in the set.
int32	GetMaxIndex()	Returns the (non-inclusive) maximum index of elements in the set.
bool	HasElement ( void* InBaseAddress, const FString& InElementValue )	Checks if an element has already been added to the set
bool	IsValidIndex ( int32 Index )	Index range check
void	MoveAssign ( void* InOtherSet )	Move the allocation from another set and make it our own.
int32	Num()	Returns the number of elements in the set.
int32	Num ( const void* Target )	Static version of Num() used when you don't need to bother to construct a FScriptSetHelper.
void	Rehash()	Rehashes the keys in the set. This function must be called to create a valid set.
void	RemoveAt ( int32 Index, int32 Count )	Removes an element at the specified index, destroying it.
bool	RemoveElement ( const void* ElementToRemove )	Removes the element from the set

Classes

	Name	Description
	FIterator

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss