AdvancedUserWidget.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2017. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BasicUserWidget.h"
#include "AdvancedUserWidget.generated.h"
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FWidgetVisibleSignature, const UObject*, ContextObject);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FWidgetCollapsedSignature);
 
UENUM(BlueprintType)
enum class EWidgetDismissType : uint8
{
    Input = 0,
    Widget = 1,
    Forced = 2
};
 
UENUM(Blueprintable)
enum EWindowToggleCommand
{
    Toggle = 0,
    Open = 1,
    Close = 2
};
 
UCLASS()
class PROJECTX_API UAdvancedUserWidget : public UBasicUserWidget
{
    GENERATED_UCLASS_BODY()
 
    friend class UProjectXGameViewportClient;
 
public:
    /* If true, this widget will auto register with the viewport client. Must be a child of a canvas panel.*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    bool bAutoRegister = false;
    /* If this is true, this widget will close all other managed widgets when activated.*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    bool bCloseOtherWidgets = true;
    /* If this is true, this widget will prevent all other managed widgets to open while it's active.*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    bool bPreventWidgetsFromOpening = false;
    /* If this is true, this widget will prevent all other lower-priority managed widgets to open while it's active.*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    bool bPreventLowerPriorityWidgetsFromOpening = false;
    /* If this is true, player input will be turned off while this widget is active.*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Input")
    bool bDisablesPlayerInputWhenActive = true;
    /* Widget will not collapse until this time has expired. Useful for delaying cleanup until an animation or fade out has completed.*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    float CollapseDelay = 0.0f;
    /* Can this widget be dismissed with a back button? (escape).*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    bool bDismissableByBackInput = true;
    /* Does opening another widget close this one?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    bool bDismissableByOtherWidgets = true;
    /* Should this widget get destroyed on level travel?*/
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Input")
    bool bDestroyOnLevelTravel = true;
    UPROPERTY(BlueprintReadWrite, EditDefaultsOnly, Category = "Controller")
    bool bAutoFocusWidget = true;
    UPROPERTY(BlueprintReadOnly, EditDefaultsOnly, Category = "Controller", meta = (EditCondition = "bAutoFocusWidget"))
    bool bRestoreLastFocusedChild = true;
    UPROPERTY(BlueprintReadWrite, EditInstanceOnly, Category = "Controller")
    UWidget* FocusPriorityWidget = nullptr;
    UPROPERTY(BlueprintReadOnly, EditDefaultsOnly, Category = "Controller")
    bool bUsesVirtualCursor = false;
    UPROPERTY(BlueprintReadOnly, EditDefaultsOnly, Category = "Controller")
    bool bRestrictNavigationToWidget = true;
    /* Does closing this widget activate another? */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Input")
    TSubclassOf<UAdvancedUserWidget> WidgetToActivateWhenClosed = nullptr;
 
    float bAutoDestroy = false;
    bool bWantsToCollapse = false;
    uint8 ZOrder = 0;
    FTimerHandle CollapseDelayTimerHandle;
    uint32 FadeOutInterpolationID = INDEX_NONE;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Events")
    FWidgetVisibleSignature OnWidgetMadeVisible;
    UPROPERTY(BlueprintAssignable, Category = "Widget Events")
    FWidgetCollapsedSignature OnWidgetWasCollapsed;
    
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnGamepadAxisMoved(const FName AxisName, const int32 ControllerId, const float Delta);
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnGamepadButtonPressed(const FInputEvent InputEvent, const int32 ControllerId);
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnLeftBumper();
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnRightBumper();
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnRightFaceButton();
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnLeftFaceButton();
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnTopFaceButton();
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnBottomFaceButton();
    UFUNCTION(BlueprintNativeEvent, Category = "Widget Events")
    bool CanDisplayWidget() const;
    UFUNCTION(BlueprintNativeEvent, Category = "Widget Events")
    void OnWidgetVisible(const UObject* ContextObject = nullptr);
    UFUNCTION(BlueprintNativeEvent, Category = "Widget Events")
    void OnWidgetDelayedCollapseStart(const UObject* ContextObject = nullptr);
 
    UFUNCTION()
    virtual bool CanDismissWidget(EWidgetDismissType Type) const;
 
    UFUNCTION(BlueprintPure, Category = "Context Menu")
    FORCEINLINE bool IsDismissable() const { return bDismissableByBackInput || bDismissableByOtherWidgets; }
 
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnMenuBack();
 
    UFUNCTION(BlueprintNativeEvent, Category = "Widget Controls")
    void CollapseWidget();
    UFUNCTION(BlueprintNativeEvent, Category = "Widget Controls")
    void SetWidgetVisible();
    UFUNCTION(BlueprintNativeEvent, BlueprintPure, Category = "Widget Controls")
    bool IsWidgetActive() const;
 
    /* Toggle this widget open or closed. This will lock player input if showing and restore if closing. */
    UFUNCTION(BlueprintCallable, Category = "Widget Controls")
    virtual void ToggleWidget(const EWindowToggleCommand ToggleCommand = EWindowToggleCommand::Toggle);
    /* Close this widget and restore player input (if applicable).*/
    UFUNCTION(BlueprintCallable, Category = "Widget Controls")
    void Close();
 
    FORCEINLINE float GetTimeSpawned() { return TimeSpawned; }
 
    UFUNCTION()
    void LevelTravel();
 
    void AlertInterfaceMenuWasToggled(bool bToggle);
 
    UWidget* GetLastFocusedWidget() { return LastFocusedWidget.Get(); }
protected:
    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;
 
    UFUNCTION(BlueprintImplementableEvent, Category = "Widget Events")
    void OnLevelTravel();
private:
    float TimeSpawned = 0.0f;
 
    void FadeWidget(float FadeTo, float Time);
    TWeakObjectPtr<UWidget> LastFocusedWidget;
};