FArticyEditorModule Class Reference

#include <ArticyEditorModule.h>

Inheritance diagram for FArticyEditorModule:

Public Member Functions
virtual void	StartupModule () override
virtual void	ShutdownModule () override
TSharedPtr< FArticyEditorCustomizationManager >	GetCustomizationManager () const
TArray< UArticyPackage * > ARTICYEDITOR_API	GetPackagesSlow ()
void	RegisterArticyToolbar ()
void	RegisterAssetTypeActions ()
void	RegisterAutoReimportExclusions ()
void	RegisterConsoleCommands ()
void	RegisterDefaultArticyIdPropertyWidgetExtensions () const
void	RegisterDetailCustomizations () const
void	RegisterDirectoryWatcher ()
void	RegisterGraphPinFactory () const
void	RegisterPluginCommands ()
void	RegisterPluginSettings () const
void	RegisterToolTabs ()
void	UnregisterPluginSettings () const
void	QueueImport ()
bool	IsImportQueued ()

Static Public Member Functions
static FArticyEditorModule &	Get ()

Public Attributes
FOnCompilationFinished	OnCompilationFinished
FOnAssetsGenerated	OnAssetsGenerated
FOnImportFinished	OnImportFinished

Detailed Description

Articy Editor Module class for managing customizations and commands for the Articy plugin in Unreal Engine.

Member Function Documentation

Get()

FArticyEditorModule & FArticyEditorModule::Get ( )

inlinestatic

Get the Articy editor module instance.

Returns

Reference to the Articy editor module.

GetCustomizationManager()

TSharedPtr< FArticyEditorCustomizationManager > FArticyEditorModule::GetCustomizationManager ( ) const

inline

Get the customization manager for Articy editor.

Returns

Shared pointer to the customization manager.

GetPackagesSlow()

TArray< UArticyPackage * > FArticyEditorModule::GetPackagesSlow

(

)

Retrieve all Articy packages in the project.

Returns

An array of Articy packages.

Retrieve all Articy packages in the project, searching through asset data.

Returns

An array of Articy packages.

IsImportQueued()

bool FArticyEditorModule::IsImportQueued

(

)

Check if an import is currently queued.

Returns

True if an import is queued, false otherwise.

QueueImport()

void FArticyEditorModule::QueueImport

(

)

Queue an import operation, displaying a message if in play mode.

RegisterArticyToolbar()

void FArticyEditorModule::RegisterArticyToolbar

(

)

Register the Articy toolbar, adding custom buttons for Articy utilities.

RegisterAssetTypeActions()

void FArticyEditorModule::RegisterAssetTypeActions

(

)

Register asset type actions for Articy global variables.

RegisterAutoReimportExclusions()

void FArticyEditorModule::RegisterAutoReimportExclusions

(

)

Tell UE's auto-reimport watcher to ignore the localization CSVs we generate so it doesn't prompt the user to import them as DataTables.

RegisterConsoleCommands()

void FArticyEditorModule::RegisterConsoleCommands

(

)

Register console commands for the Articy editor module.

RegisterDefaultArticyIdPropertyWidgetExtensions()

void FArticyEditorModule::RegisterDefaultArticyIdPropertyWidgetExtensions

(

)

const

Registers all default widget extensions. As of this point, the articy button

Register default Articy ID property widget extensions for Windows platforms.

RegisterDetailCustomizations()

void FArticyEditorModule::RegisterDetailCustomizations

(

)

const

Register detail customizations for Articy properties and settings.

RegisterDirectoryWatcher()

void FArticyEditorModule::RegisterDirectoryWatcher

(

)

Register a directory watcher to monitor changes in the generated code directory.

RegisterGraphPinFactory()

void FArticyEditorModule::RegisterGraphPinFactory

(

)

const

Register a custom graph pin factory for Articy references.

RegisterPluginCommands()

void FArticyEditorModule::RegisterPluginCommands

(

)

Register plugin commands for opening the Articy importer and debugger.

RegisterPluginSettings()

void FArticyEditorModule::RegisterPluginSettings

(

)

const

Register plugin settings for the Articy editor in the project settings.

RegisterToolTabs()

void FArticyEditorModule::RegisterToolTabs

(

)

Register tool tabs for the Articy editor, including the main menu and debugger.

ShutdownModule()

void FArticyEditorModule::ShutdownModule ( )

overridevirtual

Clean up the Articy editor module by unregistering settings and destroying console commands.

StartupModule()

void FArticyEditorModule::StartupModule ( )

overridevirtual

IModuleInterface implementation

Initialize the Articy editor module by registering customizations, commands, and toolbars.

UnregisterPluginSettings()

void FArticyEditorModule::UnregisterPluginSettings

(

)

const

Unregister plugin settings for the Articy editor in the project settings.

Member Data Documentation

OnCompilationFinished

FOnCompilationFinished FArticyEditorModule::OnCompilationFinished

Delegate to bind custom logic you want to perform after the import has successfully finished

---

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

• Source/ArticyEditor/Public/ArticyEditorModule.h
• Source/ArticyEditor/Private/ArticyEditorModule.cpp