HotReloadInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/CoreNative.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "Misc/CompilationResult.h"
 
enum class EHotReloadFlags : uint8
{
    None = 0x00,
 
    // Should not return until the recompile and reload has completed
    WaitForCompletion = 0x01
};
ENUM_CLASS_FLAGS(EHotReloadFlags)
 
enum class ERecompileModuleFlags : uint8
{
    None = 0x00,
 
    // Perform a reload of the module after the recompile finishes
    ReloadAfterRecompile = 0x01,
 
    // Report failure if UHT-generated code changes as a result of the recompile
    FailIfGeneratedCodeChanges = 0x02,
 
    // Even if this is not code-based project compile with game project as the target for UBT (do not use UnrealEditor target)
    ForceCodeProject = 0x04,
};
ENUM_CLASS_FLAGS(ERecompileModuleFlags)
 
 
class IHotReloadInterface : public IModuleInterface
{
public:
    static inline IHotReloadInterface* GetPtr()
    {
        static FName HotReload("HotReload");
        return FModuleManager::GetModulePtr<IHotReloadInterface>(HotReload);
    }
 
    virtual void SaveConfig() = 0;
 
    virtual FString GetModuleCompileMethod(FName InModuleName) = 0;
 
    virtual bool RecompileModule(const FName InModuleName, FOutputDevice &Ar, ERecompileModuleFlags Flags) = 0;
 
    virtual bool IsCurrentlyCompiling() const = 0;
 
    virtual void RequestStopCompilation() = 0;
 
    UE_DEPRECATED(5.0, "AddHotReloadFunctionRemap has been deprecated, use ReloadNotifyFunctionRemap in Reload.h instead")
    virtual void AddHotReloadFunctionRemap(FNativeFuncPtr NewFunctionPointer, FNativeFuncPtr OldFunctionPointer) = 0;
 
    virtual ECompilationResult::Type DoHotReloadFromEditor(EHotReloadFlags Flags) = 0;
 
    virtual ECompilationResult::Type RebindPackages(const TArray<UPackage*>& Packages, EHotReloadFlags Flags, FOutputDevice &Ar) = 0;
 
    DECLARE_MULTICAST_DELEGATE_OneParam(FHotReloadEvent, bool /* bWasTriggeredAutomatically */ );
    UE_DEPRECATED(5.0, "OnHotReload has been deprecated, use FCoreUObjectDelegates::ReloadCompleteDelegate.")
    virtual FHotReloadEvent& OnHotReload() = 0;
 
    DECLARE_MULTICAST_DELEGATE_OneParam(FModuleCompilerStartedEvent, bool /*bIsAsyncCompile*/);
    virtual FModuleCompilerStartedEvent& OnModuleCompilerStarted() = 0;
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FModuleCompilerFinishedEvent, const FString&, ECompilationResult::Type, bool);
    virtual FModuleCompilerFinishedEvent& OnModuleCompilerFinished() = 0;
 
    virtual bool IsAnyGameModuleLoaded() = 0;
};