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 > Core > Containers > TArray > HeapPop > TArray::HeapPop

Light Theme

Dark Theme

TArray::HeapPop

Removes the top 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

template<class PREDICATE_CLASS>
void HeapPop
(
    ElementType & OutItem,
    const PREDICATE_CLASS & Predicate,
    bool bAllowShrinking
)

Remarks

Removes the top element from the heap.

@note If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

Parameters

Parameter	Description
OutItem	The removed item.
Predicate	Predicate class instance.

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

Take our survey

Dismiss