Navigation
API > API/Editor > API/Editor/PackagesDialog
| Name | FPackagesDialogModule |
| Type | class |
| Header File | /Engine/Source/Editor/PackagesDialog/Public/PackagesDialog.h |
| Include Path | #include "PackagesDialog.h" |
Syntax
class FPackagesDialogModule : public IModuleInterface
Implements Interfaces
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DEFAULT_WINDOW_SIZE | const FVector2D | A default window size for the package dialog | PackagesDialog.h |
| EXTRA_WINDOW_WIDTH | const FVector2D | Extra window width if source control connection is allowed | PackagesDialog.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CheckedPackages | TArray< UPackage * > | The results of the dialog will be stored in these arrays | PackagesDialog.h | |
| EditorPackagesDialogWindow | TWeakPtr< SWindow > | Editor package dialog window | PackagesDialog.h | |
| PackageDialogTitle | TAttribute< FText > | The title of the dialog window | PackagesDialog.h | |
| PackagesDialogWidget | TSharedPtr< class SPackagesDialog > | Packages Dialog Widget to use in the package dialog | PackagesDialog.h | |
| UncheckedPackages | TArray< UPackage * > | PackagesDialog.h | ||
| UndeterminedPackages | TArray< UPackage * > | PackagesDialog.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddButton
(
EDialogReturnType Type, |
Adds a new button to the package dialog windowAdds a new button to the package dialog window | PackagesDialog.h | |
virtual void AddButton
(
EDialogReturnType Type, |
Adds a new button to the package dialog window | PackagesDialog.h | |
virtual void AddPackageItem
(
UPackage* InPackage, |
Adds a new item to the checkbox that represents a package | PackagesDialog.h | |
virtual void CreatePackagesDialog
(
const FText& Title, |
Used to create the package dialog window | PackagesDialog.h | |
virtual void GetResults
(
TArray< UPackage* >& OutPackages, |
Populates the passed in array with the desired packages | PackagesDialog.h | |
virtual bool IsWindowInitialized () |
Checks to see if the package dialog window is currently initialized | PackagesDialog.h | |
virtual void RemoveAllPackageItems() |
Removes all package items from the dialog | PackagesDialog.h | |
virtual void RemovePackagesDialog() |
Removes the package dialog window | PackagesDialog.h | |
virtual void SetMessage
(
const FText& InMessage |
Sets the message displayed in the package dialog | PackagesDialog.h | |
virtual void SetWarning
(
const FText& InMessage |
Sets the warning message displayed in the package dialog | PackagesDialog.h | |
virtual EDialogReturnType ShowPackagesDialog () |
Shows the package dialog window as a modal window | PackagesDialog.h | |
virtual EDialogReturnType ShowPackagesDialog
(
OUT TSet< FString >& InOutIgnoredPackages |
Shows the package dialog window as a modal window | PackagesDialog.h | |
virtual void ShutdownModule() |
Called before the module is unloaded, right before the module object is destroyed. | PackagesDialog.h | |
virtual void StartupModule () |
Called right after the module DLL has been loaded and the module object has been created | PackagesDialog.h | |
virtual bool SupportsDynamicReloading() |
Override this to set whether your module is allowed to be unloaded on the fly | PackagesDialog.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnModulesChanged
(
FName ModuleThatChanged, |
Called when a module has been changed (unloaded, loaded, etc) | PackagesDialog.h |