UIManagementSubsystem.h

이 파일의 문서화 페이지로 가기

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameplayTagContainer.h"
#include "Data/UI/UIContext.h"
#include "Interface/Level/StreamingEventListenerInterface.h"
#include "Subsystems/GameInstanceSubsystem.h"
#include "UIManagementSubsystem.generated.h"
 
class UUILayer;
class UUserWidgetBase;
struct FUILayerConfig;
 
 
UCLASS()
class CK_UE_API UUIManagementSubsystem : public UGameInstanceSubsystem, public IStreamingEventListenerInterface
{
    GENERATED_BODY()
 
public:
    UUIManagementSubsystem();
 
public:
    virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    virtual void Deinitialize() override;
 
public:
    virtual void OnLevelLoaded(ULevel* NewLevel, const ULevelStreamingData* LevelStreamingData) override { }
    virtual void OnLevelUnloaded() override;
    virtual void OnLevelStreamingStarted() override { }
    virtual void OnLevelStreamingEnded() override { }
 
public:
    // 위젯을 생성해 레이어에 푸시한다.
    // Context.bActivateOnPush == true(기본값)이고 레이어가 보이는 상태면 Activate(), 숨김 상태면 Collapsed.
    // Context.bActivateOnPush == false면 레이어 가시성과 무관하게 Activate()를 호출하지 않는다.
    // Context.bCanIncludeInSnapshot == true면 체크포인트 롤백 시 Pop되도록 SnapshotSubsystem에 기록할 수 있다.
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUserWidgetBase* PushWidget(const FUIContext& Context, AActor* OwningActor, UUILayer*& OutLayer);
 
    // PushWidget 의 PlayerController 자동 주입 버전. 활성화 규칙은 PushWidget 과 동일.
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUserWidgetBase* PushPlayerWidget(const FUIContext& Context, UUILayer*& OutLayer);
 
    // 이미 생성된 위젯 인스턴스를 푸시한다. Widget->PushToLayer()를 통해 BP 오버라이드를 거친다.
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUserWidgetBase* PushWidgetInstance(UUserWidgetBase* Widget, int32 ZOrder, UUILayer*& OutLayer);
 
    // PushToLayer_Implementation 에서 호출하는 직접 경로. BP 오버라이드를 거치지 않는다.
    void PushWidgetDirect(UUserWidgetBase* Widget, int32 ZOrder, UUILayer*& OutLayer);
 
    UFUNCTION(BlueprintCallable, Category = "UI", meta = (DefaultToSelf = "Widget", HidePin = "Widget"))
    bool PopWidget(UUserWidgetBase* Widget);
    
    UFUNCTION(BlueprintCallable, Category = "UI", meta = (DefaultToSelf = "Widget"))
    void PopWidgetFromLayer(UUserWidgetBase* Widget, UUILayer* Layer);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    void PopAllWidgetsInLayer(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    void PopAllLayer(bool WithPrimaryWidgets = false);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUILayer* GetLayer(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag) const;
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUserWidgetBase* FindFirstWidgetByArgs(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag, const TSubclassOf<UUserWidget> ClassType) const;
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUILayer* GetTopLayer() const;
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUILayer* GetRootLayer() const;
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    UUILayer* CreateLayer(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag, TSubclassOf<UUILayer> LayerClass = nullptr);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    void RemoveLayer(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    void ShowLayer(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    void HideLayer(UPARAM(meta = (Categories = "UI.Layer")) FGameplayTag LayerTag);
 
    UFUNCTION(BlueprintCallable, Category = "UI")
    void ClearAllLayers();
    
    UFUNCTION(BlueprintCallable, Category = "UI")
    int32 GetWidgetCountInLayer(UPARAM(meta = (Categories = "UI.Layer")) const FGameplayTagContainer& UILayerTags);
 
#if WITH_EDITOR
    void PrintAllLayers();
#endif
 
private:
    // 푸시 단일 진입점. 레이어 확보 → 뷰포트 부착 → 활성화(bActivateOnPush && 레이어 보임 → Activate(),
    // bActivateOnPush && 레이어 숨김 → Collapsed, !bActivateOnPush → 아무것도 안 함) → 입력 모드 갱신.
    UUserWidgetBase* PushWidgetToLayer(UUserWidgetBase* Widget, FGameplayTag LayerTag, int32 ZOrder, UUILayer*& OutLayer, bool bActivateOnPush = true, bool bCanIncludeInSnapshot = false);
    UUILayer* GetOrCreateLayer(FGameplayTag LayerTag);
    void UpdateInputMode();
 
    // 최상위 레이어가 요구하는 배율을 TimeManagementSubsystem 에 반영한다.
    void ApplyLayerTimeScale(float LayerTimeScale);
 
    // 현재 최상위 레이어가 요구하는 전역 시간 배율.
    float GetActiveLayerTimeScale() const;
 
    // 다른 시스템이 시간을 되돌렸을 때, 아직 떠 있는 레이어의 요구를 다시 주장한다.
    void HandleTimeScaleRaised(float NewTimeScale);
 
private:
    UPROPERTY(Transient)
    TArray<TObjectPtr<UUILayer>> LayerStack;
};