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 > Slate > Framework > Application > FMenuStack > FMenuStack::GetToolTipForceFieldRect

Light Theme

Dark Theme

FMenuStack::GetToolTipForceFieldRect

Called by the application when showing tooltips.

Windows

MacOS

Linux

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Application/MenuStack.h
Include	#include "Framework/Application/MenuStack.h"
Source	/Engine/Source/Runtime/Slate/Private/Framework/Application/MenuStack.cpp

Syntax

bool GetToolTipForceFieldRect
(
    const TSharedRef< IMenu > & InMenu,
    const FWidgetPath & InPathContainingMenu,
    FSlateRect & OutSlateRect
) const

Remarks

Called by the application when showing tooltips. It prevents tooltips from drawing over menu items. If the resulting bool is false, the resulting OutSlateRect will be [0,0,0,0] and should not be used.

Returns

A bool indicating whether a solution was found. If false, the resulting OutSlateRect will be [0,0,0,0] and should not be used.

Parameters

Parameter	Description
InMenu	A menu in the stack, used to generate the force field rect
InPathContainingMenu	A widget path containing InMenu. This could be generated but the application has the path so it helps performance to pass it in here.
OutSlateRect	The output rectangle enclosing the menu's children (created from the clipping rects in the geometry in PathContainingMenu)

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

Take our survey

Dismiss