PreLoadScreen.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Widgets/SWindow.h"
 
#include "IAnalyticsProviderET.h"
 
enum class EPreLoadScreenTypes : uint8
{
    CustomSplashScreen,
    EarlyStartupScreen,
    EngineLoadingScreen
};
 
// Interface that defines the class that handles all the logic for controlling / displaying a particular PreLoadScreen.
// Designed to be implemented in a Plugin that calls FPreLoadScreenManager::RegisterPreLoadScreen so that functions are called by PreLoadScreenManager correctly.
// Really should probably inherit from FPreLoadScreenBase instead of this class for more functionality
class IPreLoadScreen : public TSharedFromThis<IPreLoadScreen>
{
public:
    virtual ~IPreLoadScreen() = default;
 
    virtual void Init() = 0;
 
    virtual void Tick(float DeltaTime) = 0;
 
    virtual float GetAddedTickDelay() = 0;
 
    virtual bool ShouldRender() const = 0;
 
    virtual void RenderTick(FRHICommandListImmediate& RHICmdList, float DeltaTime) = 0;
 
    virtual void OnPlay(TWeakPtr<SWindow> TargetWindow) = 0;
 
    virtual void OnStop() = 0;
 
    virtual bool IsDone() const = 0;
 
    virtual void CleanUp() = 0;
 
    virtual EPreLoadScreenTypes GetPreLoadScreenType() const = 0;
 
    virtual FName GetPreLoadScreenTag() const = 0;
 
    virtual void SetEngineLoadingFinished(bool IsEngineLoadingFinished) = 0;
 
    virtual const TSharedPtr<const SWidget> GetWidget() const = 0;
    virtual TSharedPtr<SWidget> GetWidget() = 0;
};