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 > Runtime > Projects > FPluginDescriptor

Light Theme

Dark Theme

FPluginDescriptor

Descriptor for plugins. Contains all the information contained within a .uplugin file.

Windows

MacOS

Linux

References

Module	Projects
Header	/Engine/Source/Runtime/Projects/Public/PluginDescriptor.h
Include	#include "PluginDescriptor.h"

Syntax

struct FPluginDescriptor

Remarks

Descriptor for plugins. Contains all the information contained within a .uplugin file.

Variables

	Name	Description
bool	bCanContainContent	Can this plugin contain content?
bool	bExplicitlyLoaded	When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.
bool	bInstalled	Signifies that the plugin was installed on top of the engine
bool	bIsBetaVersion	Marks the plugin as beta in the UI
bool	bIsExperimentalVersion	Marks the plugin as experimental in the UI
bool	bIsHidden	For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.
bool	bIsPluginExtension	If true, this plugin from a platform extension extending another plugin
bool	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
FString	Category	The name of the category this plugin
FString	CreatedBy	The company or individual who created this plugin.
FString	CreatedByURL	Hyperlink URL string for the company or individual who created this plugin. This is optional.
FString	Description	Description of the plugin
FString	DocsURL	Documentation URL string.
EPluginEnabledB...	EnabledByDefault	Whether this plugin should be enabled by default for all projects
FString	EngineVersion	Version of the engine that this plugin is compatible with
FString	FriendlyName	Friendly name of the plugin
TArray< FLocali...	LocalizationTargets	List of all localization targets associated with this plugin
FString	MarketplaceURL	Marketplace URL for this plugin.
TArray< FModule...	Modules	List of all modules associated with this plugin
FString	ParentPluginName	If specified, this is the real plugin that this one is just extending
TArray< FPlugin...	Plugins	Dependent plugins
FCustomBuildSte...	PostBuildSteps	Post-build steps for each host platform
FCustomBuildSte...	PreBuildSteps	Pre-build steps for each host platform
TArray< FString...	SupportedPrograms	List of programs that are supported by this plugin.
TArray< FString...	SupportedTargetPlatforms	List of target platforms supported by this plugin.
FString	SupportURL	Support URL/email for this plugin.
int32	Version	Version number for the plugin.
FString	VersionName	Name of the version for this plugin.

Constructors

	Name	Description
	FPluginDescriptor()	Constructor.

Functions

	Name	Description
bool	Load ( const FString& FileName, FText& OutFailReason )	Loads the descriptor from the given file.
bool	Read ( const FString& Text, FText& OutFailReason )	Reads the descriptor from the given string
bool	Read ( const FJsonObject& Object, FText& OutFailReason )	Reads the descriptor from the given JSON object
bool	Save ( const FString& FileName, FText& OutFailReason )	Saves the descriptor from the given file.
bool	SupportsTargetPlatform ( const FString& Platform )	Determines whether the plugin supports the given platform
void	Write ( FString& Text )	Writes a descriptor to JSON
void	Write ( TJsonWriter<>& Writer )	Writes a descriptor to JSON

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

Take our survey

Dismiss