Module |
|
Header |
/Engine/Source/Runtime/Projects/Public/PluginDescriptor.h |
Include |
#include "PluginDescriptor.h" |
struct FPluginDescriptor
Descriptor for plugins. Contains all the information contained within a .uplugin file.
Name | Description | ||
---|---|---|---|
|
bCanContainContent |
Can this plugin contain content? |
|
|
bExplicitlyLoaded |
When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically. |
|
|
bInstalled |
Signifies that the plugin was installed on top of the engine |
|
|
bIsBetaVersion |
Marks the plugin as beta in the UI |
|
|
bIsExperimentalVersion |
Marks the plugin as experimental in the UI |
|
|
bIsHidden |
For auto-generated plugins that should not be listed in the plugin browser for users to disable freely. |
|
|
bIsPluginExtension |
If true, this plugin from a platform extension extending another plugin |
|
|
bRequiresBuildPlatform |
For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available |
|
|
Category |
The name of the category this plugin |
|
|
CreatedBy |
The company or individual who created this plugin. |
|
|
CreatedByURL |
Hyperlink URL string for the company or individual who created this plugin. This is optional. |
|
|
Description |
Description of the plugin |
|
|
DocsURL |
Documentation URL string. |
|
|
EnabledByDefault |
Whether this plugin should be enabled by default for all projects |
|
|
EngineVersion |
Version of the engine that this plugin is compatible with |
|
|
FriendlyName |
Friendly name of the plugin |
|
|
LocalizationTargets |
List of all localization targets associated with this plugin |
|
|
MarketplaceURL |
Marketplace URL for this plugin. |
|
|
Modules |
List of all modules associated with this plugin |
|
|
ParentPluginName |
If specified, this is the real plugin that this one is just extending |
|
|
Plugins |
Dependent plugins |
|
|
PostBuildSteps |
Post-build steps for each host platform |
|
|
PreBuildSteps |
Pre-build steps for each host platform |
|
|
SupportedPrograms |
List of programs that are supported by this plugin. |
|
|
SupportedTargetPlatforms |
List of target platforms supported by this plugin. |
|
|
SupportURL |
Support URL/email for this plugin. |
|
|
Version |
Version number for the plugin. |
|
|
VersionName |
Name of the version for this plugin. |
Name | Description | |
---|---|---|
|
FPluginDescriptor() |
Constructor. |
Name | Description | ||
---|---|---|---|
|
Load |
Loads the descriptor from the given file. |
|
|
Read |
Reads the descriptor from the given string |
|
|
Read ( |
Reads the descriptor from the given JSON object |
|
|
Save |
Saves the descriptor from the given file. |
|
|
SupportsTargetPlatform ( |
Determines whether the plugin supports the given platform |
|
|
Write ( |
Writes a descriptor to JSON |
|
|
Write ( |
Writes a descriptor to JSON |