LEAP Documentation 40220
Documentation for the LEAP project
UContextMenuWidget Class Reference

#include <ContextMenuWidget.h>

Inheritance diagram for UContextMenuWidget:
UAdvancedUserWidget UBasicUserWidget

Public Member Functions

void Populate ()
 
void SetText (const FText &NewMessage)
 
void SetTitle (const FText &NewMessage)
 
void ChooseContextMenuOption (const uint8 ChosenOption, const bool bCloseWindow=true)
 
- Public Member Functions inherited from UAdvancedUserWidget
void OnGamepadAxisMoved (const FName AxisName, const int32 ControllerId, const float Delta)
 
void OnGamepadButtonPressed (const FInputEvent InputEvent, const int32 ControllerId)
 
void OnLeftBumper ()
 
void OnRightBumper ()
 
void OnRightFaceButton ()
 
void OnLeftFaceButton ()
 
void OnTopFaceButton ()
 
void OnBottomFaceButton ()
 
bool CanDisplayWidget () const
 
void OnWidgetVisible (const UObject *ContextObject=nullptr)
 
void OnWidgetDelayedCollapseStart (const UObject *ContextObject=nullptr)
 
virtual bool CanDismissWidget (EWidgetDismissType Type) const
 
FORCEINLINE bool IsDismissable () const
 
void OnMenuBack ()
 
void CollapseWidget ()
 
void SetWidgetVisible ()
 
bool IsWidgetActive () const
 
virtual void ToggleWidget (const EWindowToggleCommand ToggleCommand=EWindowToggleCommand::Toggle)
 
void Close ()
 
FORCEINLINE float GetTimeSpawned ()
 
void LevelTravel ()
 
void AlertInterfaceMenuWasToggled (bool bToggle)
 
UWidget * GetLastFocusedWidget ()
 

Static Public Member Functions

static FContextMenuOption MakeContextMenuOption (const FText &Text, const FContextMenuSignature &EventOnSelected)
 

Public Attributes

TArray< FContextMenuOptionContextMenuItems
 
FText Title
 
FText Message
 
- Public Attributes inherited from UAdvancedUserWidget
bool bAutoRegister = false
 
bool bCloseOtherWidgets = true
 
bool bPreventWidgetsFromOpening = false
 
bool bPreventLowerPriorityWidgetsFromOpening = false
 
bool bDisablesPlayerInputWhenActive = true
 
float CollapseDelay = 0.0f
 
bool bDismissableByBackInput = true
 
bool bDismissableByOtherWidgets = true
 
bool bDestroyOnLevelTravel = true
 
bool bAutoFocusWidget = true
 
bool bRestoreLastFocusedChild = true
 
UWidget * FocusPriorityWidget = nullptr
 
bool bUsesVirtualCursor = false
 
bool bRestrictNavigationToWidget = true
 
TSubclassOf< UAdvancedUserWidgetWidgetToActivateWhenClosed = nullptr
 
float bAutoDestroy = false
 
bool bWantsToCollapse = false
 
uint8 ZOrder = 0
 
FTimerHandle CollapseDelayTimerHandle
 
uint32 FadeOutInterpolationID = INDEX_NONE
 
FWidgetVisibleSignature OnWidgetMadeVisible
 
FWidgetCollapsedSignature OnWidgetWasCollapsed
 

Additional Inherited Members

- Protected Member Functions inherited from UAdvancedUserWidget
virtual void NativeConstruct () override
 
virtual void NativeDestruct () override
 
void CacheFocusedElement ()
 
UWidget * GetFocusedChild (const UUserWidget *Widget)
 
virtual void AddToScreen (class ULocalPlayer *LocalPlayer, int32 inZOrder) override
 
virtual FReply NativeOnFocusReceived (const FGeometry &InGeometry, const FFocusEvent &InFocusEvent) override
 
virtual class UProjectXGameViewportClientGetViewportClient () const
 
void OnLevelTravel ()
 
- Protected Member Functions inherited from UBasicUserWidget
virtual void NativeConstruct () override
 
virtual void NativeDestruct () override
 
virtual void SetVisibility (ESlateVisibility NewVisibility) override
 
virtual void UpdateWorldStatus ()
 
virtual void WorldReady ()
 
void OnWorldReady ()
 
- Protected Attributes inherited from UBasicUserWidget
FTimerHandle WorldStatusTimer
 
bool bWaitForPawn = true
 
bool bUseVisibilitySemaphore = false
 

Member Function Documentation

◆ ChooseContextMenuOption()

void UContextMenuWidget::ChooseContextMenuOption ( const uint8  ChosenOption,
const bool  bCloseWindow = true 
)

◆ MakeContextMenuOption()

FContextMenuOption UContextMenuWidget::MakeContextMenuOption ( const FText &  Text,
const FContextMenuSignature &  EventOnSelected 
)
static

◆ Populate()

void UContextMenuWidget::Populate ( )

◆ SetText()

void UContextMenuWidget::SetText ( const FText &  NewMessage)

◆ SetTitle()

void UContextMenuWidget::SetTitle ( const FText &  NewMessage)

Member Data Documentation

◆ ContextMenuItems

TArray<FContextMenuOption> UContextMenuWidget::ContextMenuItems

◆ Message

FText UContextMenuWidget::Message

◆ Title

FText UContextMenuWidget::Title

The documentation for this class was generated from the following files: