Navigation
API > API/Editor > API/Editor/UnrealEd
Description of a plugin template
| Name | FPluginTemplateDescription |
| Type | struct |
| Header File | /Engine/Source/Editor/UnrealEd/Public/Features/IPluginsEditorFeature.h |
| Include Path | #include "Features/IPluginsEditorFeature.h" |
Syntax
struct FPluginTemplateDescription
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPluginTemplateDescription
(
FText InName, |
Constructor | Features/IPluginsEditorFeature.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPluginTemplateDescription() |
Features/IPluginsEditorFeature.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanBePlacedInEngine | bool | Can the plugin be in the engine folder? | Features/IPluginsEditorFeature.h | |
| bCanContainContent | bool | Can the plugin contain content? | Features/IPluginsEditorFeature.h | |
| bSupportsContentOnlyProjects | bool | Can the plugin be used in a content only project? | Features/IPluginsEditorFeature.h | |
| Description | FText | Description of this template in the GUI | Features/IPluginsEditorFeature.h | |
| LoadingPhase | ELoadingPhase::Type | What is the expected Loading Phase for this plugin? | Features/IPluginsEditorFeature.h | |
| ModuleDescriptorType | EHostType::Type | What is the expected ModuleDescriptor type for this plugin? | Features/IPluginsEditorFeature.h | |
| Name | FText | Name of this template in the GUI | Features/IPluginsEditorFeature.h | |
| OnDiskPath | FString | Path to the directory containing template files | Features/IPluginsEditorFeature.h | |
| PluginIconDynamicImageBrush | TSharedPtr< FSlateDynamicImageBrush > | Brush resource for the image that is dynamically loaded | Features/IPluginsEditorFeature.h | |
| SortPriority | int32 | Sorting priority (higer values go to the top of the list) | Features/IPluginsEditorFeature.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CustomizeDescriptorBeforeCreation
(
FPluginDescriptor& Descriptor |
Called just before the plugin is created | Features/IPluginsEditorFeature.h | |
virtual void OnPluginCreated
(
TSharedPtr< IPlugin > NewPlugin |
Called after the plugin has been created | Features/IPluginsEditorFeature.h | |
virtual void UpdatePathWhenTemplateSelected
(
FString& InOutPath |
Called to enforce any restrictions this template has on paths when it is first selected (so it doesn't generate an error unnecessarily) | Features/IPluginsEditorFeature.h | |
virtual void UpdatePathWhenTemplateUnselected
(
FString& InOutPath |
Called to change away from special folders if needed | Features/IPluginsEditorFeature.h | |
virtual void UpdatePluginNameTextWhenTemplateSelected
(
FText& OutPluginNameText |
Called to optionally set the default plugin name text | Features/IPluginsEditorFeature.h | |
virtual void UpdatePluginNameTextWhenTemplateUnselected
(
FText& OutPluginNameText |
Called to optionally unset the default plugin name text | Features/IPluginsEditorFeature.h | |
| Called to perform additional path validation when the path is modified (the bCanBePlacedInEngine validation will have already occurred and passed by this point) | Features/IPluginsEditorFeature.h |