Navigation
API > API/Plugins > API/Plugins/StormSyncEditor
Main entry point and implementation of StormSync Core Editor module.
| Name | FStormSyncEditorModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncEditor/Public/StormSyncEditor.h |
| Include Path | #include "StormSyncEditor.h" |
Syntax
class FStormSyncEditorModule : public IModuleInterface
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetFolderContextMenu | TSharedPtr< FStormSyncAssetFolderContextMenu > | Holds our context menu handler | StormSyncEditor.h | |
| ConnectionsCriticalSection | FCriticalSection | Critical section to allow for ThreadSafe updating of registered connections | StormSyncEditor.h | |
| ConsoleCommands | TArray< IConsoleObject * > | References of registered console commands via IConsoleManager | StormSyncEditor.h | |
| RegisteredConnections | TMap< FMessageAddress, FStormSyncConnectedDevice > | Map of active message bus connections over storm sync network | StormSyncEditor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Submenu extension delegate to build submenu for compare actions (useful for UI extensions) | StormSyncEditor.h | ||
void BuildPushAssetsMenuSection
(
FMenuBuilder& InMenuBuilder, |
Submenu extension delegate to build submenu for Push and Pull actions (useful for UI extensions) | StormSyncEditor.h | |
TSharedRef< IStormSyncImportWizard > CreateWizard
(
const TArray< FStormSyncImportFileInfo >& InFilesToImport, |
Opens the dialog in a modal new window | StormSyncEditor.h | |
| Exposed helper from `FStormSyncAssetFolderContextMenu_ utilities to check if a set of PackageNames contains any unsaved (dirty) assets (useful for UI extensions). | StormSyncEditor.h | ||
TMap< FMessageAddress, FStormSyncConnectedDevice > GetRegisteredConnections() |
Returns a copy of the map of active connections | StormSyncEditor.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ShutdownModule() |
StormSyncEditor.h | ||
virtual void StartupModule() |
StormSyncEditor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FStormSyncEditorModule & Get () |
Singleton-like access to this module's interface. | StormSyncEditor.h | |
static FText GetEntryTooltipForRemote
(
const FMessageAddress& InRemoteAddress, |
StormSyncEditor.h |