TArray::HeapRemoveAt

Removes an element from the heap.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Containers/Array.h

Include

#include "Containers/Array.h"

Syntax

void HeapRemoveAt
(
    SizeType Index,
    bool bAllowShrinking
)

Remarks

Removes an element from the heap. Assumes < operator is defined for the template type.

@note If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

Parameters

Parameter

Description

Index

Position at which to remove item.

bAllowShrinking

(Optional) Tells if this call can shrink the array allocation if suitable after the remove (default = true).

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