FAIToolKitEditorModule Class Reference

#include <AIToolKitEditor.h>

Inheritance diagram for FAIToolKitEditorModule:

Public Member Functions
virtual void	StartupModule () override
virtual void	ShutdownModule () override
UAIToolKitEditorSettings *	GetSettings () const
void	RegisterAIToolKitEditorWidget ()

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

Protected Attributes
UAIToolKitEditorSettings *	ModuleSettings

Member Function Documentation

Get()

static FAIToolKitEditorModule & FAIToolKitEditorModule::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<FAIToolKitEditorModule>("AIToolKitEditor");
    }

GetSettings()

UAIToolKitEditorSettings * FAIToolKitEditorModule::GetSettings

(

)

const

Getter for internal settings object to support runtime configuration changes

IsAvailable()

static bool FAIToolKitEditorModule::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("AIToolKitEditor");
    }

RegisterAIToolKitEditorWidget()

void FAIToolKitEditorModule::RegisterAIToolKitEditorWidget

(

)

ShutdownModule()

void FAIToolKitEditorModule::ShutdownModule ( )

overridevirtual

{
    //----------------------------------------------------------------------
    //-----------------------------------Settings
    //----------------------------------------------------------------------
    if (ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
    {
        SettingsModule->UnregisterSettings("Project", "Plugins", "Quest System");
    }
 
    if (!GExitPurge)
    {
        ModuleSettings->RemoveFromRoot();
    }
    else
    {
        ModuleSettings = nullptr;
    }
 
#if WITH_GAMEPLAY_DEBUGGER
    if (IGameplayDebugger::IsAvailable())
    {
        IGameplayDebugger& GameplayDebuggerModule = IGameplayDebugger::Get();
        GameplayDebuggerModule.UnregisterCategory("AIToolKit");
        GameplayDebuggerModule.NotifyCategoriesChanged();
    }
#endif // WITH_GAMEPLAY_DEBUGGER
 
 
}

StartupModule()

void FAIToolKitEditorModule::StartupModule ( )

overridevirtual

{
    ModuleSettings = NewObject<UAIToolKitEditorSettings>(GetTransientPackage(), "AIToolKitEditorSettings", RF_Standalone);
    ModuleSettings->AddToRoot();
    // Register settings
    if (ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
    {
        SettingsModule->RegisterSettings("Project", "Plugins", "AIToolKit",
            LOCTEXT("RuntimeSettingsName", "AIToolKit"),
            LOCTEXT("RuntimeSettingsDescription", "Configure AI Tool Kit Plugin settings"),
            ModuleSettings);
    }
#if WITH_GAMEPLAY_DEBUGGER
    IGameplayDebugger& GameplayDebuggerModule = IGameplayDebugger::Get();
    GameplayDebuggerModule.RegisterCategory("AIToolKit", IGameplayDebugger::FOnGetCategory::CreateStatic(&FGameplayDebuggerCategory_AIToolKit::MakeInstance));
    GameplayDebuggerModule.NotifyCategoriesChanged();
#endif
 
}

Member Data Documentation

ModuleSettings

UAIToolKitEditorSettings* FAIToolKitEditorModule::ModuleSettings

protected

Quest Editor Module settings

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKitEditor/Public/AIToolKitEditor.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKitEditor/Private/AIToolKitEditor.cpp