HUDBasicUserWidget.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BasicUserWidget.h"
#include "HUDBasicUserWidget.generated.h"
 
UCLASS()
class PROJECTX_API UHUDBasicUserWidget : public UBasicUserWidget
{
    GENERATED_BODY()
    
public:
    virtual bool ToggleHUDWidget(bool bToggle);
    UFUNCTION(BlueprintCallable, Category = "HUD Widget")
    bool CanBeHidden() const;
    UFUNCTION(BlueprintCallable, Category = "HUD Widget")
    FORCEINLINE bool CanBeDestroyed() const { return bCanBeDestroyed; }
 
    UFUNCTION(BlueprintCallable, Category = "HUD Widget", meta = (WorldContext = "WorldContextObject", CallableWithoutWorldContext))
    void AddHUDBasicUserWidgetToWidgetList();
    UFUNCTION(BlueprintCallable, Category = "HUD Widget", meta = (WorldContext = "WorldContextObject", CallableWithoutWorldContext))
    void RemoveHUDBasicUserWidgetFromWidgetList();
    UFUNCTION(BlueprintImplementableEvent)
    void AddChildWidget(UUserWidget* ChildWidget);
 
protected:
    //Can this HUD Widget be destroyed?
    UPROPERTY(EditDefaultsOnly, Category = "HUD Widget")
    bool bCanBeDestroyed = true;
    //Can this HUD Widget be hidden at all?
    UPROPERTY(EditDefaultsOnly, Category = "HUD Widget")
    bool bCanBeHidden = true;
    //Should this HUD Widget use a visibility count based on Show/Hide requests to decide if it can be hidden or shown?
    UPROPERTY(EditDefaultsOnly, Category = "HUD Widget")
    bool bUseVisibilityCount = false;
 
private:
    //Track of Show / Hide requests
    int VisibilityCount = 0;
};