1. Epic GamesDeveloper
  3. FPluginDescriptor

FPluginDescriptor

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

API > API/Runtime > API/Runtime/Projects

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

   
Name FPluginDescriptor
Type struct
Header File /Engine/Source/Runtime/Projects/Public/PluginDescriptor.h
Include Path #include "PluginDescriptor.h"

Syntax

struct FPluginDescriptor

Constructors

Name Remarks Include Path Unreal Specifiers

FPluginDescriptor()

 Constructor. PluginDescriptor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalFieldsToRemove TSet< FString > Additional fields to remove when updating the Json PluginDescriptor.h  
AdditionalFieldsToWrite TMap< FString, TSharedPtr< FJsonValue > > Additional fields to write PluginDescriptor.h  
bCanContainContent bool Can this plugin contain content? PluginDescriptor.h  
bCanContainVerse bool Can this plugin contain Verse code? PluginDescriptor.h  
bEnableIAD bool Use IAD for this plugin PluginDescriptor.h  
bEnableSceneGraph bool Whether this plugin has SceneGraph enabled, which impacts the generated Verse Asset Digest. PluginDescriptor.h  
bEnableVerseAssetReflection bool If to generate Verse source code definitions from assets contained in this plugin PluginDescriptor.h  
bExplicitlyLoaded bool When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically. PluginDescriptor.h  
bHasExplicitPlatforms bool When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions PluginDescriptor.h  
bInstalled bool Signifies that the plugin was installed on top of the engine PluginDescriptor.h  
bIsBetaVersion bool Marks the plugin as beta in the UI PluginDescriptor.h  
bIsExperimentalVersion bool Marks the plugin as experimental in the UI PluginDescriptor.h  
bIsHidden bool For auto-generated plugins that should not be listed in the plugin browser for users to disable freely. PluginDescriptor.h  
bIsPluginExtension bool If true, this plugin from a platform extension extending another plugin PluginDescriptor.h  
bIsSealed bool Prevents other plugins from depending on this plugin. PluginDescriptor.h  
bNoCode bool Prevents this plugin from containing code or modules. PluginDescriptor.h  
bRequiresBuildPlatform bool 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 PluginDescriptor.h  
CachedJson TSharedPtr< FJsonObject > Cached json for custom data PluginDescriptor.h  
Category FString The name of the category this plugin PluginDescriptor.h  
CreatedBy FString The company or individual who created this plugin. PluginDescriptor.h  
CreatedByURL FString Hyperlink URL string for the company or individual who created this plugin. This is optional. PluginDescriptor.h  
DeprecatedEngineVersion FString Set when a plugin is loaded that has the DeprecatedEngineVersion set. PluginDescriptor.h  
Description FString Description of the plugin PluginDescriptor.h  
DisallowedPlugins TArray< FPluginDisallowedDescriptor > Plugins that cannot be used by this plugin PluginDescriptor.h  
DocsURL FString Documentation URL string. PluginDescriptor.h  
EditorCustomVirtualPath FString Optional custom virtual path to display in editor to better organize. PluginDescriptor.h  
EnabledByDefault EPluginEnabledByDefault Whether this plugin should be enabled by default for all projects PluginDescriptor.h  
EngineVersion FString Version of the engine that this plugin is compatible with PluginDescriptor.h  
FriendlyName FString Friendly name of the plugin PluginDescriptor.h  
LocalizationTargets TArray< FLocalizationTargetDescriptor > List of all localization targets associated with this plugin PluginDescriptor.h  
MarketplaceURL FString Marketplace URL for this plugin. PluginDescriptor.h  
Modules TArray< FModuleDescriptor > List of all modules associated with this plugin PluginDescriptor.h  
ParentPluginName FString If specified, this is the real plugin that this one is just extending PluginDescriptor.h  
Plugins TArray< FPluginReferenceDescriptor > Plugins used by this plugin PluginDescriptor.h  
PostBuildSteps FCustomBuildSteps Post-build steps for each host platform PluginDescriptor.h  
PreBuildSteps FCustomBuildSteps Pre-build steps for each host platform PluginDescriptor.h  
SupportedPrograms TArray< FString > List of programs that are supported by this plugin. PluginDescriptor.h  
SupportedTargetPlatforms TArray< FString > Controls a subset of platforms that can use this plugin, and which ones will stage the .uplugin file and content files. PluginDescriptor.h  
SupportURL FString Support URL/email for this plugin. PluginDescriptor.h  
VersePath FString The Verse path to the root of this plugin's content directory PluginDescriptor.h  
VerseScope EVerseScope::Type Origin/visibility of Verse code in this plugin's Content/Verse folder PluginDescriptor.h  
VerseVersion TOptional< uint32 > The version of the Verse language that this plugin targets. PluginDescriptor.h  
Version int32 Version number for the plugin. PluginDescriptor.h  
VersionName FString Name of the version for this plugin. PluginDescriptor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Load ( const TCHAR* FileName,
FText* OutFailReason
)

 Loads the descriptor from the given file. PluginDescriptor.h  

bool Load ( const FString& FileName,
FText* OutFailReason
)

 Loads the descriptor from the given file. PluginDescriptor.h  

bool Load ( const FString& FileName,
FText& OutFailReason
)

 Loads the descriptor from the given file. PluginDescriptor.h  

bool Read ( const FJsonObject& Object,
FText& OutFailReason
)

 Reads the descriptor from the given JSON object PluginDescriptor.h  

bool Read ( const FJsonObject& Object,
FText* OutFailReason
)

 Reads the descriptor from the given JSON object PluginDescriptor.h  

bool Read ( const FString& Text,
FText& OutFailReason
)

 Reads the descriptor from the given string PluginDescriptor.h  

bool Read ( const FString& Text,
FText* OutFailReason
)

 Reads the descriptor from the given string PluginDescriptor.h  

bool Save ( const TCHAR* FileName,
FText* OutFailReason
) const

 Saves the descriptor to the given file. PluginDescriptor.h  

bool Save ( const FString& FileName,
FText* OutFailReason
) const

 Saves the descriptor to the given file. PluginDescriptor.h  

bool Save ( const FString& FileName,
FText& OutFailReason
) const

 Saves the descriptor to the given file. PluginDescriptor.h  

bool SupportsTargetPlatform ( const FString& Platform
) const

 Determines whether the plugin supports the given platform PluginDescriptor.h  

void UpdateJson ( FJsonObject& JsonObject
) const

 Updates the given json object with values in this descriptor PluginDescriptor.h  

bool UpdatePluginFile ( const FString& FileName,
FText* OutFailReason
) const

 Updates the content of the specified plugin file with values in this descriptor (hence preserving json fields that the plugin descriptor doesn't know about) PluginDescriptor.h  

bool UpdatePluginFile ( const FString& FileName,
FText& OutFailReason
) const

 Updates the content of the specified plugin file with values in this descriptor (hence preserving json fields that the plugin descriptor doesn't know about) PluginDescriptor.h  

void Write ( FString& Text
) const

 Writes a descriptor to JSON PluginDescriptor.h  

void Write ( TJsonWriter<>& Writer
) const

 Writes a descriptor to JSON PluginDescriptor.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FString & GetFileExtension()

 Return the .uplugin extension (with dot) PluginDescriptor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page