UAdvancedUserWidget Class Reference

#include <AdvancedUserWidget.h>

Inheritance diagram for UAdvancedUserWidget:

Public Member Functions
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 ()

Public Attributes
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< UAdvancedUserWidget >	WidgetToActivateWhenClosed = nullptr
float	bAutoDestroy = false
bool	bWantsToCollapse = false
uint8	ZOrder = 0
FTimerHandle	CollapseDelayTimerHandle
uint32	FadeOutInterpolationID = INDEX_NONE
FWidgetVisibleSignature	OnWidgetMadeVisible
FWidgetCollapsedSignature	OnWidgetWasCollapsed

Protected Member Functions
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 UProjectXGameViewportClient *	GetViewportClient () 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 ()

Friends
class	UProjectXGameViewportClient

Additional Inherited Members
Protected Attributes inherited from UBasicUserWidget
FTimerHandle	WorldStatusTimer
bool	bWaitForPawn = true
bool	bUseVisibilitySemaphore = false

Member Function Documentation

AddToScreen()

void UAdvancedUserWidget::AddToScreen ( class ULocalPlayer *  LocalPlayer, int32  inZOrder  )

overrideprotectedvirtual

AlertInterfaceMenuWasToggled()

void UAdvancedUserWidget::AlertInterfaceMenuWasToggled

(

bool

bToggle

)

CacheFocusedElement()

void UAdvancedUserWidget::CacheFocusedElement ( )

protected

CanDismissWidget()

bool UAdvancedUserWidget::CanDismissWidget ( EWidgetDismissType  Type ) const

virtual

Reimplemented in UDeployScreenWidget.

CanDisplayWidget()

bool UAdvancedUserWidget::CanDisplayWidget

(

)

const

Close()

void UAdvancedUserWidget::Close

(

)

CollapseWidget()

void UAdvancedUserWidget::CollapseWidget

(

)

GetFocusedChild()

UWidget * UAdvancedUserWidget::GetFocusedChild ( const UUserWidget *  Widget )

protected

GetLastFocusedWidget()

UWidget * UAdvancedUserWidget::GetLastFocusedWidget ( )

inline

GetTimeSpawned()

FORCEINLINE float UAdvancedUserWidget::GetTimeSpawned ( )

inline

GetViewportClient()

UProjectXGameViewportClient * UAdvancedUserWidget::GetViewportClient ( ) const

protectedvirtual

IsDismissable()

FORCEINLINE bool UAdvancedUserWidget::IsDismissable ( ) const

inline

IsWidgetActive()

bool UAdvancedUserWidget::IsWidgetActive

(

)

const

LevelTravel()

void UAdvancedUserWidget::LevelTravel

(

)

NativeConstruct()

void UAdvancedUserWidget::NativeConstruct ( )

overrideprotectedvirtual

Reimplemented from UBasicUserWidget.

Reimplemented in USubMenuWidget.

NativeDestruct()

void UAdvancedUserWidget::NativeDestruct ( )

overrideprotectedvirtual

Reimplemented from UBasicUserWidget.

NativeOnFocusReceived()

FReply UAdvancedUserWidget::NativeOnFocusReceived ( const FGeometry &  InGeometry, const FFocusEvent &  InFocusEvent  )

overrideprotectedvirtual

OnBottomFaceButton()

void UAdvancedUserWidget::OnBottomFaceButton

(

)

OnGamepadAxisMoved()

void UAdvancedUserWidget::OnGamepadAxisMoved	(	const FName	AxisName,
		const int32	ControllerId,
		const float	Delta
	)

OnGamepadButtonPressed()

void UAdvancedUserWidget::OnGamepadButtonPressed	(	const FInputEvent	InputEvent,
		const int32	ControllerId
	)

OnLeftBumper()

void UAdvancedUserWidget::OnLeftBumper

(

)

OnLeftFaceButton()

void UAdvancedUserWidget::OnLeftFaceButton

(

)

OnLevelTravel()

void UAdvancedUserWidget::OnLevelTravel ( )

protected

OnMenuBack()

void UAdvancedUserWidget::OnMenuBack

(

)

OnRightBumper()

void UAdvancedUserWidget::OnRightBumper

(

)

OnRightFaceButton()

void UAdvancedUserWidget::OnRightFaceButton

(

)

OnTopFaceButton()

void UAdvancedUserWidget::OnTopFaceButton

(

)

OnWidgetDelayedCollapseStart()

void UAdvancedUserWidget::OnWidgetDelayedCollapseStart

(

const UObject *

ContextObject = nullptr

)

OnWidgetVisible()

void UAdvancedUserWidget::OnWidgetVisible

(

const UObject *

ContextObject = nullptr

)

SetWidgetVisible()

void UAdvancedUserWidget::SetWidgetVisible

(

)

ToggleWidget()

void UAdvancedUserWidget::ToggleWidget ( const EWindowToggleCommand  ToggleCommand = EWindowToggleCommand::Toggle )

virtual

Reimplemented in UQuickChatWidget, and UChatBoxWidget.

Friends And Related Function Documentation

UProjectXGameViewportClient

friend class UProjectXGameViewportClient

friend

Member Data Documentation

bAutoDestroy

float UAdvancedUserWidget::bAutoDestroy = false

bAutoFocusWidget

bool UAdvancedUserWidget::bAutoFocusWidget = true

bAutoRegister

bool UAdvancedUserWidget::bAutoRegister = false

bCloseOtherWidgets

bool UAdvancedUserWidget::bCloseOtherWidgets = true

bDestroyOnLevelTravel

bool UAdvancedUserWidget::bDestroyOnLevelTravel = true

bDisablesPlayerInputWhenActive

bool UAdvancedUserWidget::bDisablesPlayerInputWhenActive = true

bDismissableByBackInput

bool UAdvancedUserWidget::bDismissableByBackInput = true

bDismissableByOtherWidgets

bool UAdvancedUserWidget::bDismissableByOtherWidgets = true

bPreventLowerPriorityWidgetsFromOpening

bool UAdvancedUserWidget::bPreventLowerPriorityWidgetsFromOpening = false

bPreventWidgetsFromOpening

bool UAdvancedUserWidget::bPreventWidgetsFromOpening = false

bRestoreLastFocusedChild

bool UAdvancedUserWidget::bRestoreLastFocusedChild = true

bRestrictNavigationToWidget

bool UAdvancedUserWidget::bRestrictNavigationToWidget = true

bUsesVirtualCursor

bool UAdvancedUserWidget::bUsesVirtualCursor = false

bWantsToCollapse

bool UAdvancedUserWidget::bWantsToCollapse = false

CollapseDelay

float UAdvancedUserWidget::CollapseDelay = 0.0f

CollapseDelayTimerHandle

FTimerHandle UAdvancedUserWidget::CollapseDelayTimerHandle

FadeOutInterpolationID

uint32 UAdvancedUserWidget::FadeOutInterpolationID = INDEX_NONE

FocusPriorityWidget

UWidget* UAdvancedUserWidget::FocusPriorityWidget = nullptr

OnWidgetMadeVisible

FWidgetVisibleSignature UAdvancedUserWidget::OnWidgetMadeVisible

OnWidgetWasCollapsed

FWidgetCollapsedSignature UAdvancedUserWidget::OnWidgetWasCollapsed

WidgetToActivateWhenClosed

TSubclassOf<UAdvancedUserWidget> UAdvancedUserWidget::WidgetToActivateWhenClosed = nullptr

ZOrder

uint8 UAdvancedUserWidget::ZOrder = 0

---

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

• E:/ProjectY/Source/ProjectX/Public/UI/AdvancedUserWidget.h
• E:/ProjectY/Source/ProjectX/Private/UI/AdvancedUserWidget.cpp