Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > PluginBrowser > IPluginWizardDefinition

Light Theme

Dark Theme

IPluginWizardDefinition

Windows

MacOS

Linux

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

	Name	Description
	~IPluginWizardDefinition()

Functions

	Name	Description
bool	AllowsEnginePlugins()	Returns true if this definition allows for the creation of engine plugins
bool	CanContainContent()	Returns true if the selected template can contain content
bool	CanShowOnStartup()	Returns true if the wizard for this definition can show on startup
void	ClearTemplateSelection()	Clears the template selection
TSharedPtr< ...	GetCustomHeaderWidget()	Returns a custom header widget for the new plugin wizard, if desired.
TArray< FStr...	GetFoldersForSelection()	Gets the folders for the current template selection
FText	GetInstructions()	Gets the instructions to be shown when creating a new plugin
FString	GetPluginFolderPath()	Gets the folder path of the current template selection
bool	GetPluginIconPath ( FString& OutIconPath )	Gets the icon path for the current template selection.
ELoadingPhas...	GetPluginLoadingPhase()	Gets the LoadingPhase for the plugin based on the selection
EHostType::T...	GetPluginModuleDescriptor()	Gets the ModuleDescriptor for the plugin based on the selection
TArray< TSha...	GetSelectedTemplates()	Returns the currently selected templates
ESelectionMo...	GetSelectionMode()	Gets the list selection mode for this definition
ECheckBoxSta...	GetShowOnStartupCheckBoxState()	Gets the state of the 'Show on Startup' checkbox.
bool	GetTemplateIconPath ( TSharedRef< FPluginTemplateDescript..., FString& OutIconPath )	Gets the icon path for the specified template. Returns true if it requires a default icon
const TArray...	GetTemplatesSource()	Returns the plugin templates available to this definition
bool	HasModules()	Returns true if the selected template will generate code
bool	HasValidTemplateSelection()	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 ( TArray< TSharedRef< FPluginTemplate..., ESelectInfo::Type SelectInfo )	Changes the selection internally to match the supplied items
void	PluginCreated ( const FString& PluginName, bool bWasSuccessful )	Called when a plugin is created, with a bool indicating whether creation was actually successful.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss