Navigation
API > API/Plugins > API/Plugins/PluginBrowser
| Name | IPluginWizardDefinition |
| Type | class |
| Header File | /Engine/Plugins/Editor/PluginBrowser/Source/PluginBrowser/Public/IPluginWizardDefinition.h |
| Include Path | #include "IPluginWizardDefinition.h" |
Syntax
class IPluginWizardDefinition : public TSharedFromThis< IPluginWizardDefinition >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IPluginWizardDefinition
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPluginWizardDefinition() |
IPluginWizardDefinition.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanShowOnStartup() |
Returns true if the wizard for this definition can show on startup | IPluginWizardDefinition.h | |
void ClearTemplateSelection() |
Clears the template selection | IPluginWizardDefinition.h | |
TSharedPtr< class SWidget > GetCustomHeaderWidget() |
Returns a custom header widget for the new plugin wizard, if desired. | IPluginWizardDefinition.h | |
| Gets the folders for the current template selection | IPluginWizardDefinition.h | ||
FText GetInstructions() |
Gets the instructions to be shown when creating a new plugin | IPluginWizardDefinition.h | |
FString GetPluginFolderPath() |
Gets the folder path of the current template selection | IPluginWizardDefinition.h | |
bool GetPluginIconPath
(
FString& OutIconPath |
Gets the icon path for the current template selection. | IPluginWizardDefinition.h | |
ELoadingPhase::Type GetPluginLoadingPhase() |
Gets the LoadingPhase for the plugin based on the selection | IPluginWizardDefinition.h | |
EHostType::Type GetPluginModuleDescriptor() |
Gets the ModuleDescriptor for the plugin based on the selection | IPluginWizardDefinition.h | |
TSharedPtr< FPluginTemplateDescription > GetSelectedTemplate() |
Returns the currently selected template | IPluginWizardDefinition.h | |
| Gets the state of the 'Show on Startup' checkbox. | IPluginWizardDefinition.h | ||
bool GetTemplateIconPath
(
TSharedRef< FPluginTemplateDescription > InTemplate, |
Gets the icon path for the specified template. Returns true if it requires a default icon | IPluginWizardDefinition.h | |
const TArray< TSharedRef< FPluginTemplateDescription > > & GetTemplatesSource() |
Returns the plugin templates available to this definition | IPluginWizardDefinition.h | |
bool HasModules() |
Returns true if the selected template will generate code | IPluginWizardDefinition.h | |
bool HasValidTemplateSelection() |
Returns true if the definition has a valid template selection | IPluginWizardDefinition.h | |
bool IsMod() |
Returns true if the plugin is a mod | IPluginWizardDefinition.h | |
void OnShowOnStartupCheckboxChanged
(
ECheckBoxState CheckBoxState |
Callback for when the 'Show on Startup' checkbox changes in the plugin wizard. | IPluginWizardDefinition.h | |
void OnTemplateSelectionChanged
(
TSharedPtr< FPluginTemplateDescription > InSelectedItem, |
Changes the selection internally to match the supplied items | IPluginWizardDefinition.h | |
void PluginCreated
(
const FString& PluginName, |
Called when a plugin is created, with a bool indicating whether creation was actually successful. | IPluginWizardDefinition.h |