IDlgSystemModule.h

Go to the documentation of this file.

// Copyright Csaba Molnar, Daniel Butum. All Rights Reserved.
#pragma once
 
#include "Modules/ModuleManager.h"
#include "Modules/ModuleInterface.h"
 
// The name of the Dialogue System plugin as defined in the .uplugin file
const FName DIALOGUE_SYSTEM_PLUGIN_NAME(TEXT("DlgSystem"));
 
class AActor;
class SWidget;
class SDockTab;
struct FTabSpawnerEntry;
 
class DLGSYSTEM_API IDlgSystemModule : public IModuleInterface
{
public:
 
    static IDlgSystemModule& Get()
    {
        return FModuleManager::LoadModuleChecked<IDlgSystemModule>(DIALOGUE_SYSTEM_PLUGIN_NAME);
    }
 
    static bool IsAvailable()
    {
        return FModuleManager::Get().IsModuleLoaded(DIALOGUE_SYSTEM_PLUGIN_NAME);
    }
 
public:
    virtual ~IDlgSystemModule() {}
 
    virtual void RegisterConsoleCommands(const TWeakObjectPtr<const UObject>& WorldContextObjectPtr) = 0;
 
    // Unregister all the console commands
    virtual void UnregisterConsoleCommands() = 0;
 
    // Gets the debug Dialogue Data Display Window.
    virtual TSharedRef<SWidget> GetDialogueDataDisplayWindow() = 0;
 
    // Gets the tab entry for the Window
    virtual FTabSpawnerEntry* GetDialogueDataDisplaySpawnEntry() = 0;
 
    // Display the debug Dialogue Data Window on the screen
    virtual void DisplayDialogueDataWindow() = 0;
};