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