#include <SGameMenuPageWidget.h>

Inheritance diagram for SGameMenuPageWidget:

Public Member Functions
	SLATE_BEGIN_ARGS (SGameMenuPageWidget)

	DECLARE_DELEGATE (FOnToggleMenu)

	DECLARE_DELEGATE_TwoParams (FOnSelectionChanged, TSharedPtr< class FGameMenuItem >, TSharedPtr< class FGameMenuItem >)

void	Construct (const FArguments &InArgs)

virtual void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override

virtual FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override

virtual bool	SupportsKeyboardFocus () const override

virtual FReply	OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent) override

virtual void	OnMainPanelStateChange (bool bWasOpened)

virtual void	OnSubPanelStateChange (bool bWasOpened)

void	SetupAnimations ()

void	EnterSubMenu (TSharedPtr< FGameMenuPage > InSubMenu)

void	MenuGoBack (bool bIsCancel=false)

void	ConfirmMenuItem ()

void	BuildAndShowMenu (TSharedPtr< FGameMenuPage > InMenu)

void	HideMenu ()

void	UpdateArrows (TSharedPtr< class FGameMenuItem > InMenuItem)

void	ChangeOption (int32 InMoveBy)

void	LockControls (bool bEnable)

void	OpenMainPanel (TSharedPtr< FGameMenuPage > InMenu)

bool	SelectItem (int32 InSelection)

void	ResetMenu ()

TSharedPtr< FGameMenuPage >	GetCurrentMenu ()

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual SLATECORE_API FChildren *	GetChildren () override

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API FSlateColor	GetForegroundColor () const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API void	OnFocusLost (const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)

virtual SLATECORE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseLeave (const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)

virtual SLATECORE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

virtual SLATECORE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual bool	IsInteractable () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Attributes
TWeakObjectPtr< UGameViewportClient >	MyGameViewport

Protected Member Functions
void	SetCurrentMenu (TSharedPtr< FGameMenuPage > InMenu)

EVisibility	GetSlateVisibility () const

EVisibility	GetSubMenuVisiblity () const

float	GetUIScale () const

void	BuildPanelButtons (TSharedPtr< FGameMenuPage > InPanel, TSharedPtr< SVerticalBox > InBox, int32 InPreviousIndex)

FLinearColor	GetPanelsColor () const

FSlateColor	GetPanelsBackgroundColor () const

FMargin	GetMainMenuOffset () const

FMargin	GetSubMenuOffset () const

FMargin	GetMenuTitleOffset () const

FMargin	GetMenuOffset () const

FMargin	GetMenuItemPadding () const

FMargin	GetSubMenuItemPadding () const

FSlateColor	GetTitleColor () const

FSlateColor	GetTextColor () const

virtual FReply	SelectionChanged (int32 SelectionIndex)

virtual FReply	MouseButtonClicked (int32 SelectionIndex)

FText	GetOptionText (TSharedPtr< class FGameMenuItem > MenuItem) const

FText	GetMenuTitle () const

EVisibility	GetMenuTitleVisibility () const

void	FadeIn ()

void	SetTitleAnimation (bool bShowTitle)

void	OpenPendingSubMenu ()

Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D	ComputeDesiredSize (float) const override

TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual bool	CustomPrepass (float LayoutScaleMultiplier)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

virtual bool	ComputeVolatility () const

virtual SLATECORE_API void	OnClippingChanged ()

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Attributes
FText	CurrentMenuTitle

bool	bConsoleVisible

FMenuPanel	MainMenuPanel

FMenuPanel	SubMenuPanel

TSharedPtr< FGameMenuPage >	NextMenu

TSharedPtr< FGameMenuPage >	CurrentMenu

TAttribute< float >	UIScale

FCurveSequence	MenuWidgetAnimation

FCurveHandle	TopColorCurve

FCurveHandle	ColorFadeCurve

FCurveHandle	MenuAnimationCurve

FCurveSequence	TitleWidgetAnimation

FCurveHandle	TitleWidgetCurve

TWeakObjectPtr< class APlayerController >	PCOwner

FIntPoint	ScreenRes

int32	MainAnimNumber

int32	SelectedIndex

uint8	bMenuHiding: 1

uint8	bMenuHidden: 1

uint8	bGameMenu: 1

uint8	bControlsLocked: 1

TSharedPtr< FGameMenuPage >	PendingMainMenu

TSharedPtr< FGameMenuPage >	PendingSubMenu

TSharedPtr< SVerticalBox >	MainPanel

TSharedPtr< SVerticalBox >	SubPanel

const FGameMenuStyle *	MenuStyle

TArray< TSharedPtr< FGameMenuPage > >	MenuHistory

FOnToggleMenu	OnToggleMenu

FOnSelectionChanged	OnSelectionChange

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Additional Inherited Members
Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Member Function Documentation

◆ BuildAndShowMenu()

void SGameMenuPageWidget::BuildAndShowMenu ( TSharedPtr< FGameMenuPage > InMenu )

Show the given menu and make it the current menu.

Parameters

InMenu The menu to show and set as the current menu. If this is NULL Current menu will be used if valid.

◆ BuildPanelButtons()

void SGameMenuPageWidget::BuildPanelButtons	(	TSharedPtr< FGameMenuPage >	InPanel,
		TSharedPtr< SVerticalBox >	InBox,
		int32	InPreviousIndex
	)

protected

Rebuild the widgets in the main menu widget. Selected item will be set from InPreviousIndex unless it is invalid.

Parameters

InPanel	The FGameMenuPage we are building the panel from.
InBox	The SVerticalBox in which to build the widgets from the given panel.
PreviousIndex	The previous menu index. (Can be INDEX_NONE)

◆ ChangeOption()

void SGameMenuPageWidget::ChangeOption ( int32 InMoveBy )

Change the currently selection option of the currently selected menu item.

Parameters

InMoveBy Number to change the option by.

◆ ConfirmMenuItem()

void SGameMenuPageWidget::ConfirmMenuItem ( )

Confirms current menu item and performs an action. Will also play selection sound.

◆ Construct()

void SGameMenuPageWidget::Construct ( const FArguments & InArgs )

every widget needs a construction function.

◆ DECLARE_DELEGATE()

SGameMenuPageWidget::DECLARE_DELEGATE ( FOnToggleMenu )

style to use for this menu item. weak pointer to the parent HUD base. is this main menu or in game menu ? always goes here Delegate to call when in-game menu should be hidden using controller buttons - it's workaround as when joystick is captured, even when sending FReply::Unhandled, binding does not receive input :(

◆ DECLARE_DELEGATE_TwoParams()

SGameMenuPageWidget::DECLARE_DELEGATE_TwoParams	(	FOnSelectionChanged	,
		TSharedPtr< class FGameMenuItem >	,
		TSharedPtr< class FGameMenuItem >
	)

Delegate for selection changing. Passes old and new selection.

◆ EnterSubMenu()

void SGameMenuPageWidget::EnterSubMenu ( TSharedPtr< FGameMenuPage > InSubMenu )

Make the currently selected menu sub menu new main menu if valid.

◆ FadeIn()

void SGameMenuPageWidget::FadeIn ( )

protected

Start the main menu open fade/anim and set keyboard focu.s

◆ GetCurrentMenu()

TSharedPtr< FGameMenuPage > SGameMenuPageWidget::GetCurrentMenu ( )

◆ GetMainMenuOffset()

FMargin SGameMenuPageWidget::GetMainMenuOffset ( ) const

protected

◆ GetMenuItemPadding()

FMargin SGameMenuPageWidget::GetMenuItemPadding ( ) const

protected

◆ GetMenuOffset()

FMargin SGameMenuPageWidget::GetMenuOffset ( ) const

protected

◆ GetMenuTitle()

FText SGameMenuPageWidget::GetMenuTitle ( ) const

protected

Gets current menu title string.

◆ GetMenuTitleOffset()

FMargin SGameMenuPageWidget::GetMenuTitleOffset ( ) const

protected

◆ GetMenuTitleVisibility()

EVisibility SGameMenuPageWidget::GetMenuTitleVisibility ( ) const

protected

Gets the menu title visibility based on if the title text is empty.

◆ GetOptionText()

FText SGameMenuPageWidget::GetOptionText ( TSharedPtr< class FGameMenuItem > MenuItem ) const

protected

Gets currently selected multi-choice option.

Parameters

SelectionIndex The index selection.

Returns: Will return UNHANDLED if the current menu is invalid, HANDLED in all other cases including if the controls are locked.

◆ GetPanelsBackgroundColor()

FSlateColor SGameMenuPageWidget::GetPanelsBackgroundColor ( ) const

protected

◆ GetPanelsColor()

FLinearColor SGameMenuPageWidget::GetPanelsColor ( ) const

protected

Misc Getters used for animating/fading various menu facets.

◆ GetSlateVisibility()

EVisibility SGameMenuPageWidget::GetSlateVisibility ( ) const

protected

Sets hit test invisibility when console is up.

◆ GetSubMenuItemPadding()

FMargin SGameMenuPageWidget::GetSubMenuItemPadding ( ) const

protected

◆ GetSubMenuOffset()

FMargin SGameMenuPageWidget::GetSubMenuOffset ( ) const

protected

◆ GetSubMenuVisiblity()

EVisibility SGameMenuPageWidget::GetSubMenuVisiblity ( ) const

protected

◆ GetTextColor()

FSlateColor SGameMenuPageWidget::GetTextColor ( ) const

protected

◆ GetTitleColor()

FSlateColor SGameMenuPageWidget::GetTitleColor ( ) const

protected

◆ GetUIScale()

float SGameMenuPageWidget::GetUIScale ( ) const

protected

Gets current scale for drawing menu.

◆ HideMenu()

void SGameMenuPageWidget::HideMenu ( )

Hide the menu.

◆ LockControls()

void SGameMenuPageWidget::LockControls ( bool bEnable )

disable/enable moving around menu.

◆ MenuGoBack()

void SGameMenuPageWidget::MenuGoBack ( bool bIsCancel = false )

Go back the the previous menu.

Parameters

bIsCancel if true will be treated as CANCEL (IE escape pressed).

◆ MouseButtonClicked()

FReply SGameMenuPageWidget::MouseButtonClicked ( int32 SelectionIndex )

protectedvirtual

Callback for handling mouse click.

Parameters

SelectionIndex The index selection.

Returns: Will return UNHANDLED if the current menu is invalid, HANDLED in all other cases including if the controls are locked.

◆ OnFocusReceived()

FReply SGameMenuPageWidget::OnFocusReceived	(	const FGeometry &	MyGeometry,
		const FFocusEvent &	InFocusEvent
	)

overridevirtual

The menu sets up the appropriate mouse settings upon focus.

Reimplemented from SWidget.

◆ OnKeyDown()

FReply SGameMenuPageWidget::OnKeyDown	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyEvent
	)

overridevirtual

Key down handler.

Reimplemented from SWidget.

◆ OnMainPanelStateChange()

void SGameMenuPageWidget::OnMainPanelStateChange ( bool bWasOpened )

virtual

Callback handler for when the state of the main panel changes.

Parameters

bWasOpened whether the panel was opened or closed. is TRUE if panel opened.

◆ OnMouseButtonDown()

FReply SGameMenuPageWidget::OnMouseButtonDown	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

Mouse button down handler.

Reimplemented from SWidget.

◆ OnSubPanelStateChange()

void SGameMenuPageWidget::OnSubPanelStateChange ( bool bWasOpened )

virtual

Callback handler for when the state of the sub panel changes.b

Parameters

bWasOpened whether the panel was opened or closed. is TRUE if panel opened.

◆ OpenMainPanel()

void SGameMenuPageWidget::OpenMainPanel ( TSharedPtr< FGameMenuPage > InMenu )

Set the current menu and 'open' it as the main panel.

Parameters

InMenu The menu to open and set as current.

◆ OpenPendingSubMenu()

void SGameMenuPageWidget::OpenPendingSubMenu ( )

protected

◆ ResetMenu()

void SGameMenuPageWidget::ResetMenu ( )

◆ SelectionChanged()

FReply SGameMenuPageWidget::SelectionChanged ( int32 SelectionIndex )

protectedvirtual

Callback for when one of the menu items is selected.

Parameters

SelectionIndex The index selection.

Returns: Will return UNHANDLED if the current menu is invalid, HANDLED in all other cases including if the controls are locked.

◆ SelectItem()

bool SGameMenuPageWidget::SelectItem ( int32 InSelection )

Select a given item from an index

Parameters

InSelection The index of the item to select

Returns: true if selection changed.

◆ SetCurrentMenu()

void SGameMenuPageWidget::SetCurrentMenu ( TSharedPtr< FGameMenuPage > InMenu )

protected

◆ SetTitleAnimation()

void SGameMenuPageWidget::SetTitleAnimation ( bool bShowTitle )

protected

Animates the title widget.

Parameters

bShowTitle true to show the title, false to hide it.

◆ SetupAnimations()

void SGameMenuPageWidget::SetupAnimations ( )

Setups misc animation sequences.

◆ SLATE_BEGIN_ARGS()

SGameMenuPageWidget::SLATE_BEGIN_ARGS ( SGameMenuPageWidget )

inline

◆ SupportsKeyboardFocus()

virtual bool SGameMenuPageWidget::SupportsKeyboardFocus ( ) const

inlineoverridevirtual

says that we can support keyboard focus.

Reimplemented from SWidget.

◆ Tick()

void SGameMenuPageWidget::Tick	(	const FGeometry &	AllottedGeometry,
		const double	InCurrentTime,
		const float	InDeltaTime
	)

overridevirtual

Update function.

Reimplemented from SWidget.

◆ UpdateArrows()

void SGameMenuPageWidget::UpdateArrows ( TSharedPtr< class FGameMenuItem > InMenuItem )

Updates arrows visibility for multi-choice menu item.

Parameters

InMenuItem The item to update.

Member Data Documentation

◆ bConsoleVisible

bool SGameMenuPageWidget::bConsoleVisible

protected

If console is currently opened.

◆ bControlsLocked

uint8 SGameMenuPageWidget::bControlsLocked

protected

If moving around menu is currently locked.

◆ bGameMenu

uint8 SGameMenuPageWidget::bGameMenu

protected

If this is in game menu.

◆ bMenuHidden

uint8 SGameMenuPageWidget::bMenuHidden

protected

Flag when playing hiding animation.

◆ bMenuHiding

uint8 SGameMenuPageWidget::bMenuHiding

protected

Flag when playing hiding animation.

◆ ColorFadeCurve

FCurveHandle SGameMenuPageWidget::ColorFadeCurve

protected

Used for menu background fade in animation at the beginning.

◆ CurrentMenu

TSharedPtr< FGameMenuPage > SGameMenuPageWidget::CurrentMenu

protected

Currently active menu.

◆ CurrentMenuTitle

FText SGameMenuPageWidget::CurrentMenuTitle

protected

Control for hiding the menu - Defaults to start button. Current menu title if present.

◆ MainAnimNumber

int32 SGameMenuPageWidget::MainAnimNumber

protected

Animation type index.

◆ MainMenuPanel

FMenuPanel SGameMenuPageWidget::MainMenuPanel

protected

Container instance for main panel.

◆ MainPanel

TSharedPtr<SVerticalBox> SGameMenuPageWidget::MainPanel

protected

Current menu layout box.

◆ MenuAnimationCurve

FCurveHandle SGameMenuPageWidget::MenuAnimationCurve

protected

Used for menu buttons slide in animation at the beginning.

◆ MenuHistory

TArray< TSharedPtr< FGameMenuPage> > SGameMenuPageWidget::MenuHistory

protected

Stack of previous menus.

◆ MenuStyle

const FGameMenuStyle* SGameMenuPageWidget::MenuStyle

protected

Style to use for this menu item.

◆ MenuWidgetAnimation

FCurveSequence SGameMenuPageWidget::MenuWidgetAnimation

protected

Our curve sequence and the related handles.

◆ MyGameViewport

TWeakObjectPtr<UGameViewportClient> SGameMenuPageWidget::MyGameViewport

◆ NextMenu

TSharedPtr< FGameMenuPage > SGameMenuPageWidget::NextMenu

protected

Next menu (for transition and displaying as the right menu).

◆ OnSelectionChange

FOnSelectionChanged SGameMenuPageWidget::OnSelectionChange

protected

Executed when the user selects an item.

◆ OnToggleMenu

FOnToggleMenu SGameMenuPageWidget::OnToggleMenu

protected

Bind if menu should be hidden from outside by controller button.

◆ PCOwner

TWeakObjectPtr<class APlayerController> SGameMenuPageWidget::PCOwner

protected

Weak pointer to our parent Player Controller.

◆ PendingMainMenu

TSharedPtr< FGameMenuPage > SGameMenuPageWidget::PendingMainMenu

protected

Menu that will override current one after transition animation.

◆ PendingSubMenu

TSharedPtr< FGameMenuPage > SGameMenuPageWidget::PendingSubMenu

protected

Menu that will become the submenu after transition animation.

◆ ScreenRes

FIntPoint SGameMenuPageWidget::ScreenRes

protected

Screen resolution.

◆ SelectedIndex

int32 SGameMenuPageWidget::SelectedIndex

protected

Selected index of current menu.

◆ SubMenuPanel

FMenuPanel SGameMenuPageWidget::SubMenuPanel

protected

Container instance for sub menu panel (only relevant with side by side layout).

◆ SubPanel

TSharedPtr<SVerticalBox> SGameMenuPageWidget::SubPanel

protected

Sub menu layout box.

◆ TitleWidgetAnimation

FCurveSequence SGameMenuPageWidget::TitleWidgetAnimation

protected

Our curve sequence and the related handles.

◆ TitleWidgetCurve

FCurveHandle SGameMenuPageWidget::TitleWidgetCurve

protected

◆ TopColorCurve

FCurveHandle SGameMenuPageWidget::TopColorCurve

protected

Used for main menu logo fade in animation at the beginning.

◆ UIScale

TAttribute<float> SGameMenuPageWidget::UIScale

protected

Current UI scale attribute.

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

Engine/Source/Runtime/GameMenuBuilder/Public/SGameMenuPageWidget.h
Engine/Source/Runtime/GameMenuBuilder/Private/SGameMenuPageWidget.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ BuildAndShowMenu()

◆ BuildPanelButtons()

◆ ChangeOption()

◆ ConfirmMenuItem()

◆ Construct()

◆ DECLARE_DELEGATE()

◆ DECLARE_DELEGATE_TwoParams()

◆ EnterSubMenu()

◆ FadeIn()

◆ GetCurrentMenu()

◆ GetMainMenuOffset()

◆ GetMenuItemPadding()

◆ GetMenuOffset()

◆ GetMenuTitle()

◆ GetMenuTitleOffset()

◆ GetMenuTitleVisibility()

◆ GetOptionText()

◆ GetPanelsBackgroundColor()

◆ GetPanelsColor()

◆ GetSlateVisibility()

◆ GetSubMenuItemPadding()

◆ GetSubMenuOffset()

◆ GetSubMenuVisiblity()

◆ GetTextColor()

◆ GetTitleColor()

◆ GetUIScale()

◆ HideMenu()

◆ LockControls()

◆ MenuGoBack()

◆ MouseButtonClicked()

◆ OnFocusReceived()

◆ OnKeyDown()

◆ OnMainPanelStateChange()

◆ OnMouseButtonDown()

◆ OnSubPanelStateChange()

◆ OpenMainPanel()

◆ OpenPendingSubMenu()

◆ ResetMenu()

◆ SelectionChanged()

◆ SelectItem()

◆ SetCurrentMenu()

◆ SetTitleAnimation()

◆ SetupAnimations()

◆ SLATE_BEGIN_ARGS()

◆ SupportsKeyboardFocus()

◆ Tick()

◆ UpdateArrows()

Member Data Documentation

◆ bConsoleVisible

◆ bControlsLocked

◆ bGameMenu

◆ bMenuHidden

◆ bMenuHiding

◆ ColorFadeCurve

◆ CurrentMenu

◆ CurrentMenuTitle

◆ MainAnimNumber

◆ MainMenuPanel

◆ MainPanel

◆ MenuAnimationCurve

◆ MenuHistory

◆ MenuStyle

◆ MenuWidgetAnimation

◆ MyGameViewport

◆ NextMenu

◆ OnSelectionChange

◆ OnToggleMenu

◆ PCOwner

◆ PendingMainMenu

◆ PendingSubMenu

◆ ScreenRes

◆ SelectedIndex

◆ SubMenuPanel

◆ SubPanel