FQuestSystemEditorModule Class Reference

#include <QuestSystemEditor.h>

Inheritance diagram for FQuestSystemEditorModule:

Public Member Functions
virtual void	StartupModule () override
virtual void	ShutdownModule () override
UQuestSystemEditorSettings *	GetSettings () const
void	RegisterQuestEditorWidget ()

Static Public Member Functions
static FQuestSystemEditorModule &	Get ()
static bool	IsAvailable ()

Protected Attributes
UQuestSystemEditorSettings *	ModuleSettings

Member Function Documentation

Get()

static FQuestSystemEditorModule & FQuestSystemEditorModule::Get ( )

inlinestatic

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns

Returns singleton instance, loading the module on demand if needed

    {
        return FModuleManager::LoadModuleChecked<FQuestSystemEditorModule>("QuestSystemEditor");
    }

GetSettings()

UQuestSystemEditorSettings * FQuestSystemEditorModule::GetSettings

(

)

const

Getter for internal settings object to support runtime configuration changes

IsAvailable()

static bool FQuestSystemEditorModule::IsAvailable ( )

inlinestatic

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Returns

True if the module is loaded and ready to use

    {
        return FModuleManager::Get().IsModuleLoaded("QuestSystemEditor");
    }

RegisterQuestEditorWidget()

void FQuestSystemEditorModule::RegisterQuestEditorWidget

(

)

ShutdownModule()

void FQuestSystemEditorModule::ShutdownModule ( )

overridevirtual

{
    //----------------------------------------------------------------------
    //-----------------------------------Settings
    //----------------------------------------------------------------------
    if (ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
    {
        SettingsModule->UnregisterSettings("Project", "Plugins", "Quest System");
    }
 
    if (!GExitPurge)
    {
        ModuleSettings->RemoveFromRoot();
    }
    else
    {
        ModuleSettings = nullptr;
    }
 
}

StartupModule()

void FQuestSystemEditorModule::StartupModule ( )

overridevirtual

{
    ModuleSettings = NewObject<UQuestSystemEditorSettings>(GetTransientPackage(), "QuestSystemEditorSettings", RF_Standalone);
    ModuleSettings->AddToRoot();
    // Register settings
    if (ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
    {
        SettingsModule->RegisterSettings("Project", "Plugins", "Quest System",
            LOCTEXT("RuntimeSettingsName", "Quest System"),
            LOCTEXT("RuntimeSettingsDescription", "Configure Quest System Plugin settings"),
            ModuleSettings);
    }
 
}

Member Data Documentation

ModuleSettings

UQuestSystemEditorSettings* FQuestSystemEditorModule::ModuleSettings

protected

Quest Editor Module settings

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/QuestSystem/Source/QuestSystemEditor/Public/QuestSystemEditor.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/QuestSystem/Source/QuestSystemEditor/Private/QuestSystemEditor.cpp