UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FGameMenuStyle Struct Reference

#include <GameMenuWidgetStyle.h>

+ Inheritance diagram for FGameMenuStyle:

Public Member Functions

 FGameMenuStyle ()
 
virtual ~FGameMenuStyle ()
 
virtual void GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
 
virtual const FName GetTypeName () const override
 
FGameMenuStyleSetMenuTopBrush (const FSlateBrush &InMenuTopBrush)
 
FGameMenuStyleSetMenuFrameBrush (const FSlateBrush &InMenuFrameBrush)
 
FGameMenuStyleSetMenuBackgroundBrush (const FSlateBrush &InMenuBackgroundBrush)
 
FGameMenuStyleSetMenuSelectBrush (const FSlateBrush &InMenuSelectBrush)
 
FGameMenuStyleSetMenuEnterSound (const FSlateSound &InMenuEnterSound)
 
FGameMenuStyleSetMenuBackSound (const FSlateSound &InMenuBackSound)
 
FGameMenuStyleSetOptionChangeSound (const FSlateSound &InOptionChangeSound)
 
FGameMenuStyleSetMenuItemChangeSound (const FSlateSound &InMenuItemChangeSound)
 
FGameMenuStyleSetMenuItemInactiveSound (const FSlateSound &InMenuItemInactiveSound)
 
FGameMenuStyleSetMenuItemChosenSound (const FSlateSound &InMenuItemChosenSound)
 
FGameMenuStyleSetMenuLeftMarginPercent (const float InLeftMarginPercent)
 
FGameMenuStyleSetSubMenuMarginPercent (const float InSubMenuMarginPercent)
 
FGameMenuStyleSetMenuTitleColor (const GameMenuLayoutType::Type InLayoutType)
 
FGameMenuStyleSetTitleBorderMargin (const FMargin InTitleBorderMargin)
 
FGameMenuStyleSetItemBorderMargin (const FMargin InItemBorderMargin)
 
FGameMenuStyleSetTitleHorizontalAlignment (const EHorizontalAlignment InTitleHorizontalAlignment)
 
FGameMenuStyleSetTitleVerticalAlignment (const EVerticalAlignment InTitleVerticalAlignment)
 
FGameMenuStyleSetPanelsVerticalAlignment (const EVerticalAlignment InPanelsVerticalAlignment)
 
FGameMenuStyleSetMainAnimDuration (const float InAnimationSpeed)
 
FGameMenuStyleSetTextColor (const FSlateColor InTextColor)
 
- Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API FSlateWidgetStyle ()
 
virtual SLATECORE_API ~FSlateWidgetStyle ()
 

Static Public Member Functions

static const FGameMenuStyleGetDefault ()
 

Public Attributes

FSlateBrush MenuTopBrush
 
FSlateBrush MenuFrameBrush
 
FSlateBrush MenuBackgroundBrush
 
FSlateBrush MenuSelectBrush
 
FSlateSound MenuEnterSound
 
FSlateSound MenuBackSound
 
FSlateSound OptionChangeSound
 
FSlateSound MenuItemChangeSound
 
FSlateSound MenuItemInactiveSound
 
FSlateSound MenuItemChosenSound
 
float LeftMarginPercent
 
float SubMenuMarginPercent
 
TEnumAsByte< GameMenuLayoutType::TypeLayoutType
 
FMargin TitleBorderMargin
 
FMargin ItemBorderMargin
 
TEnumAsByte< EHorizontalAlignmentTitleHorizontalAlignment
 
TEnumAsByte< EVerticalAlignmentTitleVerticalAlignment
 
TEnumAsByte< EVerticalAlignmentPanelsVerticalAlignment
 
float AnimationSpeed
 
FSlateColor TextColor
 

Static Public Attributes

static const FName TypeName
 

Constructor & Destructor Documentation

◆ FGameMenuStyle()

FGameMenuStyle::FGameMenuStyle ( )

◆ ~FGameMenuStyle()

FGameMenuStyle::~FGameMenuStyle ( )
virtual

Member Function Documentation

◆ GetDefault()

const FGameMenuStyle & FGameMenuStyle::GetDefault ( )
static

◆ GetResources()

void FGameMenuStyle::GetResources ( TArray< const FSlateBrush * > &  OutBrushes) const
overridevirtual

Gets the brush resources associated with this style.

This method must be implemented by inherited structures.

Parameters
OutBrushesThe brush resources.

Reimplemented from FSlateWidgetStyle.

◆ GetTypeName()

virtual const FName FGameMenuStyle::GetTypeName ( ) const
inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns
Widget style name.

Reimplemented from FSlateWidgetStyle.

◆ SetItemBorderMargin()

FGameMenuStyle & FGameMenuStyle::SetItemBorderMargin ( const FMargin  InItemBorderMargin)
inline

◆ SetMainAnimDuration()

FGameMenuStyle & FGameMenuStyle::SetMainAnimDuration ( const float  InAnimationSpeed)
inline

◆ SetMenuBackgroundBrush()

FGameMenuStyle & FGameMenuStyle::SetMenuBackgroundBrush ( const FSlateBrush InMenuBackgroundBrush)
inline

◆ SetMenuBackSound()

FGameMenuStyle & FGameMenuStyle::SetMenuBackSound ( const FSlateSound InMenuBackSound)
inline

◆ SetMenuEnterSound()

FGameMenuStyle & FGameMenuStyle::SetMenuEnterSound ( const FSlateSound InMenuEnterSound)
inline

◆ SetMenuFrameBrush()

FGameMenuStyle & FGameMenuStyle::SetMenuFrameBrush ( const FSlateBrush InMenuFrameBrush)
inline

◆ SetMenuItemChangeSound()

FGameMenuStyle & FGameMenuStyle::SetMenuItemChangeSound ( const FSlateSound InMenuItemChangeSound)
inline

◆ SetMenuItemChosenSound()

FGameMenuStyle & FGameMenuStyle::SetMenuItemChosenSound ( const FSlateSound InMenuItemChosenSound)
inline

◆ SetMenuItemInactiveSound()

FGameMenuStyle & FGameMenuStyle::SetMenuItemInactiveSound ( const FSlateSound InMenuItemInactiveSound)
inline

◆ SetMenuLeftMarginPercent()

FGameMenuStyle & FGameMenuStyle::SetMenuLeftMarginPercent ( const float  InLeftMarginPercent)
inline

◆ SetMenuSelectBrush()

FGameMenuStyle & FGameMenuStyle::SetMenuSelectBrush ( const FSlateBrush InMenuSelectBrush)
inline

◆ SetMenuTitleColor()

FGameMenuStyle & FGameMenuStyle::SetMenuTitleColor ( const GameMenuLayoutType::Type  InLayoutType)
inline

◆ SetMenuTopBrush()

FGameMenuStyle & FGameMenuStyle::SetMenuTopBrush ( const FSlateBrush InMenuTopBrush)
inline

◆ SetOptionChangeSound()

FGameMenuStyle & FGameMenuStyle::SetOptionChangeSound ( const FSlateSound InOptionChangeSound)
inline

◆ SetPanelsVerticalAlignment()

FGameMenuStyle & FGameMenuStyle::SetPanelsVerticalAlignment ( const EVerticalAlignment  InPanelsVerticalAlignment)
inline

◆ SetSubMenuMarginPercent()

FGameMenuStyle & FGameMenuStyle::SetSubMenuMarginPercent ( const float  InSubMenuMarginPercent)
inline

◆ SetTextColor()

FGameMenuStyle & FGameMenuStyle::SetTextColor ( const FSlateColor  InTextColor)
inline

◆ SetTitleBorderMargin()

FGameMenuStyle & FGameMenuStyle::SetTitleBorderMargin ( const FMargin  InTitleBorderMargin)
inline

◆ SetTitleHorizontalAlignment()

FGameMenuStyle & FGameMenuStyle::SetTitleHorizontalAlignment ( const EHorizontalAlignment  InTitleHorizontalAlignment)
inline

◆ SetTitleVerticalAlignment()

FGameMenuStyle & FGameMenuStyle::SetTitleVerticalAlignment ( const EVerticalAlignment  InTitleVerticalAlignment)
inline

Member Data Documentation

◆ AnimationSpeed

float FGameMenuStyle::AnimationSpeed

Speed at which the menu initially appears.

◆ ItemBorderMargin

FMargin FGameMenuStyle::ItemBorderMargin

Item border margin.

◆ LayoutType

TEnumAsByte<GameMenuLayoutType::Type> FGameMenuStyle::LayoutType

Layout type.

◆ LeftMarginPercent

float FGameMenuStyle::LeftMarginPercent

The left hand margin for the main menu

◆ MenuBackgroundBrush

FSlateBrush FGameMenuStyle::MenuBackgroundBrush

The brush used to draw the menu background

◆ MenuBackSound

FSlateSound FGameMenuStyle::MenuBackSound

The sound the menu should play when returning to a parent menu

◆ MenuEnterSound

FSlateSound FGameMenuStyle::MenuEnterSound

The sound the menu should play when entering a sub-menu

◆ MenuFrameBrush

FSlateBrush FGameMenuStyle::MenuFrameBrush

The brush used to draw the menu border

◆ MenuItemChangeSound

FSlateSound FGameMenuStyle::MenuItemChangeSound

The sound the menu should play when the selected menu item is changed

◆ MenuItemChosenSound

FSlateSound FGameMenuStyle::MenuItemChosenSound

The sound the menu should play when the selected menu item is chosen

◆ MenuItemInactiveSound

FSlateSound FGameMenuStyle::MenuItemInactiveSound

The sound the menu should play when the selected menu item is disabled or unbound

◆ MenuSelectBrush

FSlateBrush FGameMenuStyle::MenuSelectBrush

The brush used to draw the selected menu item

◆ MenuTopBrush

FSlateBrush FGameMenuStyle::MenuTopBrush

The brush used to draw the top of the menu

◆ OptionChangeSound

FSlateSound FGameMenuStyle::OptionChangeSound

The sound the menu should play when a menu option is changed

◆ PanelsVerticalAlignment

TEnumAsByte<EVerticalAlignment> FGameMenuStyle::PanelsVerticalAlignment

Panel vertical alignment.

◆ SubMenuMarginPercent

float FGameMenuStyle::SubMenuMarginPercent

The left hand margin for the sub menu

◆ TextColor

FSlateColor FGameMenuStyle::TextColor

Color of the text.

◆ TitleBorderMargin

FMargin FGameMenuStyle::TitleBorderMargin

Title border margin.

◆ TitleHorizontalAlignment

TEnumAsByte<EHorizontalAlignment> FGameMenuStyle::TitleHorizontalAlignment

Title horizontal alignment.

◆ TitleVerticalAlignment

TEnumAsByte<EVerticalAlignment> FGameMenuStyle::TitleVerticalAlignment

Title vertical alignment.

◆ TypeName

const FName FGameMenuStyle::TypeName
static

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