1. Epic GamesDeveloper
  3. FScriptSetHelper

FScriptSetHelper

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

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

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. Note that the set can contain invalid entries some number of valid entries (i.e. Num() ) can be smaller that the actual number of elements (i.e. GetMaxIndex() ).

Internal index naming is used to identify the actual index in the container which can point to an invalid entry. It can be used for methods like GetPtr, GetPtrWithoutCheck or IsValidIndex.

Logical index naming is used to identify only valid entries in the container so it can be smaller than the internal index in case we skipped invalid entries to reach the next valid one. This index is used on method like FindNthPtr or FindInternalIndex. This is also the type of index we receive from most editor events (e.g. property change events) so it is strongly suggested to rely on FScriptSetHelper::FIterator to iterate or convert to internal index.

Variables

  Type Name Description
Public variable FProperty * ElementProp  
Public variable FScriptSet * Set  
Public variable FScriptSetLayout SetLayout  

Constructors

  Type Name Description
Public function  

FScriptSetHelper ( const FSetProperty* InProperty,
const void* InSet
)

 Constructor, brings together a property and an instance of the property located in memory

Functions

  Type Name Description
Public function int32 Adds a blank, constructed value to a given size.
Public function 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
Public function int32 Add an uninitialized value to the end of the set.
Public function Static FScriptSetHelper

CreateHelperFormElementProperty ( FProperty* InElementProperty,
const void* InSet
)

  
Public function Const FIterator

CreateIterator ( const int32 InLogicalIndex
)

  
Public function Const FIterator  
Public function void

EmptyElements ( int32 Slack
)

 Remove all values from the set, calling destructors, etc as appropriate.
Public function Const int32

FindElementIndex ( const void* ElementToFind,
int32 IndexHint
)

 Finds the index of an element in a set
Public function Const int32

FindElementIndexFromHash ( const void* ElementToFind
)

 Finds element index from hash, rather than linearly searching
Public function uint8 *

FindElementPtr ( const void* ElementToFind,
int32 IndexHint
)

 Finds the pair in a map which matches the key in another pair.
Public function uint8 *

FindElementPtrFromHash ( const void* ElementToFind
)

 Finds element pointer from hash, rather than linearly searching
Public function Const int32

FindInternalIndex ( int32 LogicalIdx
)

 Sets 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.
Public function Const int32

FindLogicalIndex ( int32 InternalIdx
)

 Sets have gaps in their indices, so this function translates a internal index to an logical index (ie. Nth element).
Public function Const const uint8 * Returns a uint8 pointer to the the Nth valid element in the set (skipping invalid entries).
Public function uint8 * Returns a uint8 pointer to the the Nth valid element in the set (skipping invalid entries).
Public function Const FProperty * Returns the property representing the element of the set
Public function Const const uint8 *

GetElementPtr ( const FIterator Iterator
)

 Returns a uint8 pointer to the element in the set.
Public function uint8 *

GetElementPtr ( const FIterator Iterator
)

 Returns a uint8 pointer to the element in the set.
Public function Const const uint8 *

GetElementPtr ( int32 InternalIndex
)

 Returns a uint8 pointer to the element in the set.
Public function uint8 *

GetElementPtr ( int32 InternalIndex
)

 Returns a uint8 pointer to the element in the set.
Public function Const int32 Returns the (non-inclusive) maximum index of elements in the set.
Public function Const bool

IsValidIndex ( int32 InternalIndex
)

 Index range check
Public function void

MoveAssign ( void* InOtherSet
)

 Move the allocation from another set and make it our own.
Public function Const int32

Num ()

 Returns the number of elements in the set.
Public function Static int32

Num ( const void* Target
)

 Static version of Num() used when you don't need to bother to construct a FScriptSetHelper.
Public function Const int32 Returns the number of elements in the set.
Public function void

Rehash ()

 Rehashes the keys in the set. This function must be called to create a valid set.
Public function void

RemoveAt ( int32 InternalIndex,
int32 Count
)

 Removes an element at the specified index, destroying it.
Public function bool

RemoveElement ( const void* ElementToRemove
)

 Removes the element from the set

Typedefs

Name Description
FIterator  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page