UOptionsMenuSystemWidget Class Reference

#include <OptionsMenuSystemWidget.h>

Inheritance diagram for UOptionsMenuSystemWidget:

Public Member Functions
virtual UWidget *	NativeGetDesiredFocusTarget () const override
virtual bool	NativeOnHandleBackAction () override
void	SaveSettings ()
void	SetCameraSensitivity (const float Value) const
void	SetCameraHorizontalSensitivity (const float Value) const
void	SetCameraVerticalSensitivity (const float Value) const
void	SetCameraUseSeparateAxisSensitivity (const bool bValue) const
void	SetCameraInverted (const bool bValue) const
float	GetCameraSensitivity () const
float	GetCameraHorizontalSensitivity () const
float	GetCameraVerticalSensitivity () const
virtual bool	GetCameraUseSeparateAxisSensitivity () const
virtual void	SetAimAssistLevel (const int32 Value)
virtual int32	GetAimAssistLevel () const
virtual void	SetCameraAimedSensitivityMultiplier (const float Value)
virtual float	GetCameraAimedSensitivityMultiplier () const
bool	GetCameraInverted () const
void	BackButtonPressed ()
Public Member Functions inherited from UMenuSystemWidget
	UMenuSystemWidget (const FObjectInitializer &ObjectInitializer)
virtual void	NativeConstruct () override
void	SetMenuInterface (IMenuSystem *Interface)
void	Setup ()
virtual void	OpenConfirmationMessage (const FModalData &ModalData)
virtual void	SetServerList (const TArray< FServerRow > &ServerInfo)
void	SetOwnerWidget (UUserWidget *Owner)
UUserWidget *	GetOwnerWidget () const
void	WidgetVisibilityChanged (ESlateVisibility SlateVisibility)
bool	GetIsOnlineGame () const
bool	GetIsPublicMatch () const
virtual bool	GetDebuggingMode () const
virtual FString	GetPlayerUserName () const
virtual bool	GetIsPlayerLoggedIn () const
virtual FString	GetCurrentSessionName () const
virtual EOnlineSubsystem	GetOnlineSubsystem () const

Public Attributes
class USingleMenuSystemWidget *	OptionsMenu = nullptr
Public Attributes inherited from UMenuSystemWidget
FOnMenuBackButtonSelected	OnMenuBackButtonSelected

Protected Member Functions
virtual bool	Initialize () override
virtual void	NativeDestruct () override
Protected Member Functions inherited from UMenuSystemWidget
virtual void	ModalButtonSelected (const int32 Index)
void	OnModalButtonSelectedEvent (const int32 Index)
virtual void	ModalClosed ()
void	OnModalClosedEvent ()
class UModalMenuSystemWidget *	GetCurrentModal () const
void	SetModalSlot (UPanelWidget *PanelWidget)
void	SetNotificationSlot (UPanelWidget *PanelWidget)
Protected Member Functions inherited from UBaseActivatableWidget
void	LogDebugError (const FString &Message) const
void	LogDebugError (const FString &Message, const int32 Value) const
void	LogDebugError (const FString &Message, const float Value) const
void	LogDebugWarning (const FString &Message) const
void	LogDebugWarning (const FString &Message, const int32 Value) const
void	LogDebugWarning (const FString &Message, const float Value) const
void	LogDebugMessage (const FString &Message, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const int32 Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const float Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const bool bValue, const bool bWarning, const bool bError) const
void	LogOnScreenMessage (const int32 Key, const FString &Message, FColor Color=FColor::Green) const
void	SetCategoryName (const FLogCategoryBase &Category)

Protected Attributes
UAudioOptionsWidget *	AudioOptionsWidget
UWidgetSwitcher *	OptionsMenuWidgetSwitcher
UButton *	AudioOptionsButton
UButton *	DisplayOptionsButton
UButton *	GameplayOptionsButton
Protected Attributes inherited from UMenuSystemWidget
IMenuSystem *	MenuInterface = nullptr
class IModalInterface *	ModalInterface = nullptr
bool	bIsController = false
bool	bIsKeyboard = false
bool	bMouse = false
Protected Attributes inherited from UBaseActivatableWidget
bool	bDebuggingMode = false

Private Member Functions
void	OptionsMenuButtonSelected (const int32 Index)

Member Function Documentation

BackButtonPressed()

void UOptionsMenuSystemWidget::BackButtonPressed

(

)

{
    IMenuSystem* MenuSystem = Cast<IMenuSystem>(GetGameInstance());
    if(MenuSystem != nullptr)
    {
        //@TODO Popup, Are you sure you want to Leave? or Save?  Y / N
        MenuSystem->LaunchOptionsMenu(GetOwningPlayer(), GetOwnerWidget(), false);
    }
}

GetAimAssistLevel()

int32 UOptionsMenuSystemWidget::GetAimAssistLevel ( ) const

virtual

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player UOptionsMenuSystemWidget::GetAimAssistLevel"))return 0;}
    return UOptionsMenuBPLib::GetAimAssistLevel(GetOwningPlayer());
}

GetCameraAimedSensitivityMultiplier()

float UOptionsMenuSystemWidget::GetCameraAimedSensitivityMultiplier ( ) const

virtual

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player UOptionsMenuSystemWidget::GetCameraAimedSensitivityMultiplier"))return 1.0f;}
    return UOptionsMenuBPLib::GetCameraAimedSensitivityMultiplier(GetOwningPlayer());
}

GetCameraHorizontalSensitivity()

float UOptionsMenuSystemWidget::GetCameraHorizontalSensitivity

(

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in GetCameraHorizontalSensitivity - Player Options Menu"))return 1.0f;}
    return UOptionsMenuBPLib::GetCameraHorizontalSensitivity(GetOwningPlayer());
}

GetCameraInverted()

bool UOptionsMenuSystemWidget::GetCameraInverted

(

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in GetCameraInverted - Player Options Menu"))return false;}
    return UOptionsMenuBPLib::GetIsCameraInverted(GetOwningPlayer());
}

GetCameraSensitivity()

float UOptionsMenuSystemWidget::GetCameraSensitivity

(

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in GetCameraSensitivity - Player Options Menu"))return 1.0f;}
    return UOptionsMenuBPLib::GetCameraSensitivity(GetOwningPlayer());
}

GetCameraUseSeparateAxisSensitivity()

bool UOptionsMenuSystemWidget::GetCameraUseSeparateAxisSensitivity ( ) const

virtual

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in GetCameraHorizontalSensitivity - Player Options Menu"))return 1.0f;}
    return UOptionsMenuBPLib::GetCameraUseSeparateAxisSensitivity(GetOwningPlayer());
}

GetCameraVerticalSensitivity()

float UOptionsMenuSystemWidget::GetCameraVerticalSensitivity

(

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in GetCameraHorizontalSensitivity - Player Options Menu"))return 1.0f;}
    return UOptionsMenuBPLib::GetCameraVerticalSensitivity(GetOwningPlayer());
}

Initialize()

bool UOptionsMenuSystemWidget::Initialize ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(OptionsMenu != nullptr)) return false;
    if (!ensure(AudioOptionsWidget != nullptr)) return false;
    if (!ensure(OptionsMenuWidgetSwitcher != nullptr)) return false;
    OptionsMenu->OnMenuButtonSelected.AddUniqueDynamic(this, &UOptionsMenuSystemWidget::OptionsMenuButtonSelected);
    bIsBackHandler = true;
    return true;
}

NativeDestruct()

void UOptionsMenuSystemWidget::NativeDestruct ( )

overrideprotectedvirtual

{
    Super::NativeDestruct();
    
}

NativeGetDesiredFocusTarget()

UWidget * UOptionsMenuSystemWidget::NativeGetDesiredFocusTarget ( ) const

overridevirtual

{
    if(OptionsMenu != nullptr)
    {
        return OptionsMenu->GetDesiredFocusTarget();
    }
    return Super::NativeGetDesiredFocusTarget();
}

NativeOnHandleBackAction()

bool UOptionsMenuSystemWidget::NativeOnHandleBackAction ( )

overridevirtual

Reimplemented from UMenuSystemWidget.

{
    BackButtonPressed();
    return Super::NativeOnHandleBackAction();
}

OptionsMenuButtonSelected()

void UOptionsMenuSystemWidget::OptionsMenuButtonSelected ( const int32 Index )

private

{
    switch (Index)
    {
    default:
    case 0:
    //-     Resume      //
        // BackButtonClicked();
        break;
    case 1:
        //-     Options     //
            // OpenOptionsMenu();
        break;
    case 2:
        //-     Save Game       //
        // SaveGame();
        break;
    case 3:
        //- Load Last Checkpoint?       //
        break;
    case 4:
        //- Restart Level   //
            // RestartLevelButtonClicked();
        break;
    case 5:
        //-     Main Menu       //
            // MainMenuButtonClicked();
        break;
    case 6:
        break;
    }
}

SaveSettings()

void UOptionsMenuSystemWidget::SaveSettings

(

)

{
    UOptionsMenuBPLib::SaveSettings();
    UOptionsMenuBPLib::SavePlayerSettings(GetOwningPlayer(), AudioOptionsWidget->GetAudioSliderValues());
    //RefreshSelections();
}

SetAimAssistLevel()

void UOptionsMenuSystemWidget::SetAimAssistLevel ( const int32 Value )

virtual

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player UOptionsMenuSystemWidget::SetAimAssistLevel"))return;}
    UOptionsMenuBPLib::SetAimAssistLevel(GetOwningPlayer(), Value);
}

SetCameraAimedSensitivityMultiplier()

void UOptionsMenuSystemWidget::SetCameraAimedSensitivityMultiplier ( const float Value )

virtual

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player UOptionsMenuSystemWidget::SetCameraAimedSensitivityMultiplier"))return;}
    return UOptionsMenuBPLib::SetCameraAimedSensitivityMultiplier(GetOwningPlayer(), Value);
}

SetCameraHorizontalSensitivity()

void UOptionsMenuSystemWidget::SetCameraHorizontalSensitivity

(

const float

Value

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in SetCameraHorizontalSensitivity - Player Options Menu"))return;}
    UOptionsMenuBPLib::SetCameraHorizontalSensitivity(GetOwningPlayer(), Value);
}

SetCameraInverted()

void UOptionsMenuSystemWidget::SetCameraInverted

(

const bool

bValue

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in Set Camera Sens - Player Options Menu"))return;}
    UOptionsMenuBPLib::SetCameraInverted(GetOwningPlayer(), bValue);
}

SetCameraSensitivity()

void UOptionsMenuSystemWidget::SetCameraSensitivity

(

const float

Value

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in Set Camera Sens - Player Options Menu"))return;}
    UOptionsMenuBPLib::SetCameraSensitivity(GetOwningPlayer(), Value);
}

SetCameraUseSeparateAxisSensitivity()

void UOptionsMenuSystemWidget::SetCameraUseSeparateAxisSensitivity

(

const bool

bValue

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in SetCameraUseSeparateAxisSensitivity - Player Options Menu"))return;}
    UOptionsMenuBPLib::SetCameraUseSeparateAxisSensitivity(GetOwningPlayer(), bValue);
}

SetCameraVerticalSensitivity()

void UOptionsMenuSystemWidget::SetCameraVerticalSensitivity

(

const float

Value

)

const

{
    if(GetOwningPlayer() == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Owning Player Failed in SetCameraVerticalSensitivity - Player Options Menu"))return;}
    UOptionsMenuBPLib::SetCameraVerticalSensitivity(GetOwningPlayer(), Value);
}

Member Data Documentation

AudioOptionsButton

UButton* UOptionsMenuSystemWidget::AudioOptionsButton

protected

AudioOptionsWidget

UAudioOptionsWidget* UOptionsMenuSystemWidget::AudioOptionsWidget

protected

DisplayOptionsButton

UButton* UOptionsMenuSystemWidget::DisplayOptionsButton

protected

GameplayOptionsButton

UButton* UOptionsMenuSystemWidget::GameplayOptionsButton

protected

OptionsMenu

class USingleMenuSystemWidget* UOptionsMenuSystemWidget::OptionsMenu = nullptr

OptionsMenuWidgetSwitcher

UWidgetSwitcher* UOptionsMenuSystemWidget::OptionsMenuWidgetSwitcher

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Public/Widgets/OptionsMenuSystemWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Private/Widgets/OptionsMenuSystemWidget.cpp