ProjectXHUD.h

Go to the documentation of this file.

// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
 
#pragma once 
 
#include "CoreMinimal.h"
#include "ContextMenuWidget.h"
#include "GameFramework/HUD.h"
#include "ProjectXHUD.generated.h"
 
class UProjectXGameViewportClient;
class UHUDBasicUserWidget;
class UTexture2D;
class UReticleWidget;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnHUDDestroyed);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnHUDVisibilityChanged, bool, bShowHUD);
 
UCLASS()
class AProjectXHUD : public AHUD
{
    GENERATED_BODY()
 
public:
    AProjectXHUD();
 
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
    virtual void DrawHUD() override;
    virtual void ShowHUD() override;
    virtual void PlayerDeath();
 
    UFUNCTION(BlueprintCallable, Category = "Menus")
    void ToggleWidgetByClass(TSubclassOf<UAdvancedUserWidget> WidgetClass, EWindowToggleCommand ToggleCommand = EWindowToggleCommand::Toggle);
    UFUNCTION(BlueprintCallable, Category = "Menus")
    UAdvancedUserWidget* CreateMenuWidget(TSubclassOf<UAdvancedUserWidget> WidgetClass, int32 ZOrder  = 1);
 
    UFUNCTION(BlueprintCallable, Category = "HUD")
    UHUDBasicUserWidget* CreateHUDUserWidget(UClass* WidgetClass, const int32 ZOrder);
    UFUNCTION(BlueprintCallable, Category = "HUD")
    void RemoveHUDUserWidget(UUserWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Accessors")
    UUserWidget* GetWidgetByType(TSubclassOf<UUserWidget> WidgetClass) const;
 
    UFUNCTION(BlueprintCallable, Category = "HUD")
    UReticleWidget* UpdateReticleWidget(TSubclassOf<UReticleWidget> WidgetClass);
 
    UFUNCTION(BlueprintCallable, Category = "HUD")
    void OpenPostGameMenu();
    UFUNCTION(BlueprintCallable, Category = "HUD")
    void ShowMatchResultWidget();
    UFUNCTION(BlueprintCallable, Category = "HUD")
    void ShowPodium();
    UFUNCTION(BlueprintCallable, Category = "HUD")
    void OpenFollowScreen();
    UFUNCTION(BlueprintCallable,Category = "HUD")
    void CloseQuickChat();
    UFUNCTION(BlueprintCallable, Category = "HUD")
    void ToggleNVIDIAReflexStats(bool bVisibility);
    UFUNCTION(BlueprintPure, Category = HUD)
    UReticleWidget* GetReticleWidget() const { return ReticleWidget.Get(); }
    UFUNCTION(BlueprintPure, Category = HUD)
    UUserWidget* GetMapWidget() const { return GetWidgetByType(MapWidgetClass); }
    UFUNCTION(BlueprintPure, Category = HUD)
    UHUDBasicUserWidget* const GetGameplayWidget() const;
    UFUNCTION(BlueprintImplementableEvent, Category = "HUD")
    void OnPlayerDeath();
    UFUNCTION(BlueprintCallable, Category = HUD)
    virtual void DeferredOpenMap(float Delay = -1.f);
 
    TSubclassOf<UAdvancedUserWidget> GetLoadoutWidget() const { return LoadoutWidgetClass; }
    TSubclassOf<UAdvancedUserWidget> GetDeployScreenWidget() const { return MapWidgetClass; }
    TSubclassOf<AActor> GetDisplayMeshClass() const { return InGameLoadoutDisplayClass; }
    UPROPERTY(BlueprintAssignable)
    FOnHUDVisibilityChanged OnHUDVisibilityChanged;
 
protected:
    UFUNCTION()
    void DrawProjectileDebug();
 
private:
    friend class UProjectXGameViewportClient;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> GameSettingsWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> MapWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> MainMenuWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> EscMenuWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> ContextMenuWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> GlobalMessageDialogueWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> ScoreboardWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> PostGameWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> KickVoteWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> MapVoteWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> QuickChatWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UUserWidget> GameModeWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> MissionResultWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> LoadoutWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> DeathWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UAdvancedUserWidget> LandingScreenWidgetClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UUserWidget> FollowWidgetClass;
    UPROPERTY(EditDefaultsOnly)
    TSubclassOf<AActor> InGameLoadoutDisplayClass;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Menus", meta = (AllowPrivateAccess = true))
    TSubclassOf<UHUDBasicUserWidget> NVIDIAReflexStatsClass;
    
    /* Our current reticle widget. */
    TWeakObjectPtr<UReticleWidget> ReticleWidget = NULL;
 
    UProjectXGameViewportClient* GetGameViewportClient() const;
 
    UPROPERTY()
    mutable UProjectXGameViewportClient* ViewportClient = nullptr;
 
    UPROPERTY(EditDefaultsOnly, Category = "Debug", meta = (AllowPrivateAccess = true))
    class UFont* DebugFont = NULL;
    // how long does the match result show on screen
    UPROPERTY(EditDefaultsOnly, Category = "UI", meta = (AllowPrivateAccess = true))
    float PostGameUIDelay = 5.0f;
    // how long does the podium show on screen
    UPROPERTY(EditDefaultsOnly, Category = "UI", meta = (AllowPrivateAccess = true))
    float PodiumDuration = 10.0f;
    /* How much time after death before opening up the deploy screen when no "DeathWidgetClass" is setup for this HUD  */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "UI", meta = (AllowPrivateAccess = true))
    float TimeBeforeShowingMapOnDeath = 12.0f;
 
public:
    /* Get the Pre-casted ProjectX HUD */
    UFUNCTION(BlueprintPure, Category = "UI", meta = (WorldContext = "WorldContextObject"))
    static AProjectXHUD* GetHUD(const UObject* WorldContextObject, const int32 Slot = 0);
    UFUNCTION(BlueprintCallable, Category = "UI", meta = (WorldContext = "WorldContextObject"))
    static UContextMenuWidget* CreateContextMenu(const UObject* WorldContextObject, TArray<FContextMenuOption> const ContextMenuOptions, const FText Title, const bool bIsDismissable = true, const UObject* ContextObject = nullptr);
    UFUNCTION(BlueprintCallable, Category = "UI", meta = (WorldContext = "WorldContextObject"))
    static UContextMenuWidget* CreateGlobalMessageDialogue(const UObject* WorldContextObject, const FContextMenuOption ContextMenuOption1, const FContextMenuOption ContextMenuOption2, const FText Title, const FText Message, const bool bIsDismissable = true, const UObject* ContextObject = nullptr);
    
};