FPluginDescriptor

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

Choose your operating system:

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

Public variable

TMap< FString, ...

 

AdditionalFieldsToWrite

Additional fields to write

Public variable

bool

 

bCanContainContent

Can this plugin contain content?

Public variable

bool

 

bCanContainVerse

Can this plugin contain Verse code?

Public variable

bool

 

bExplicitlyLoaded

When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.

Public variable

bool

 

bHasExplicitPlatforms

When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions

Public variable

bool

 

bInstalled

Signifies that the plugin was installed on top of the engine

Public variable

bool

 

bIsBetaVersion

Marks the plugin as beta in the UI

Public variable

bool

 

bIsExperimentalVersion

Marks the plugin as experimental in the UI

Public variable

bool

 

bIsHidden

For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.

Public variable

bool

 

bIsPluginExtension

If true, this plugin from a platform extension extending another plugin

Public variable

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

Public variable

TSharedPtr< FJs...

 

CachedJson

Cached json for custom data

Public variable

FString

 

Category

The name of the category this plugin

Public variable

FString

 

CreatedBy

The company or individual who created this plugin.

Public variable

FString

 

CreatedByURL

Hyperlink URL string for the company or individual who created this plugin. This is optional.

Public variable

FString

 

Description

Description of the plugin

Public variable

FString

 

DocsURL

Documentation URL string.

Public variable

FString

 

EditorCustomVirtualPath

Optional custom virtual path to display in editor to better organize.

Public variable

EPluginEnabledB...

 

EnabledByDefault

Whether this plugin should be enabled by default for all projects

Public variable

FString

 

EngineVersion

Version of the engine that this plugin is compatible with

Public variable

FString

 

FriendlyName

Friendly name of the plugin

Public variable

TArray< FLocali...

 

LocalizationTargets

List of all localization targets associated with this plugin

Public variable

FString

 

MarketplaceURL

Marketplace URL for this plugin.

Public variable

TArray< FModule...

 

Modules

List of all modules associated with this plugin

Public variable

FString

 

ParentPluginName

If specified, this is the real plugin that this one is just extending

Public variable

TArray< FPlugin...

 

Plugins

Plugins used by this plugin

Public variable

FCustomBuildSte...

 

PostBuildSteps

Post-build steps for each host platform

Public variable

FCustomBuildSte...

 

PreBuildSteps

Pre-build steps for each host platform

Public variable

TArray< FString...

 

SupportedPrograms

List of programs that are supported by this plugin.

Public variable

TArray< FString...

 

SupportedTargetPlatforms

Controls a subset of platforms that can use this plugin, and which ones will stage the .uplugin file and content files.

Public variable

FString

 

SupportURL

Support URL/email for this plugin.

Public variable

int32

 

Version

Version number for the plugin.

Public variable

FString

 

VersionName

Name of the version for this plugin.

Constructors

Name Description

Public function

FPluginDescriptor()

Constructor.

Functions

Name Description

Public function Static

const FStrin...

 

GetFileExtension()

Return the .uplugin extension (with dot)

Public function

bool

 

Load

(
    const FString& FileName,
    FText* OutFailReason
)

Loads the descriptor from the given file.

Public function

bool

 

Load

(
    const FString& FileName,
    FText& OutFailReason
)

Loads the descriptor from the given file.

Public function

bool

 

Read

(
    const FString& Text,
    FText* OutFailReason
)

Reads the descriptor from the given string

Public function

bool

 

Read

(
    const FString& Text,
    FText& OutFailReason
)

Reads the descriptor from the given string

Public function

bool

 

Read

(
    const FJsonObject& Object,
    FText* OutFailReason
)

Reads the descriptor from the given JSON object

Public function

bool

 

Read

(
    const FJsonObject& Object,
    FText& OutFailReason
)

Reads the descriptor from the given JSON object

Public function Const

bool

 

Save

(
    const FString& FileName,
    FText* OutFailReason
)

Saves the descriptor from the given file.

Public function Const

bool

 

Save

(
    const FString& FileName,
    FText& OutFailReason
)

Saves the descriptor from the given file.

Public function Const

bool

 

SupportsTargetPlatform

(
    const FString& Platform
)

Determines whether the plugin supports the given platform

Public function Const

void

 

UpdateJson

(
    FJsonObject& JsonObject
)

Updates the given json object with values in this descriptor

Public function Const

bool

 

UpdatePluginFile

(
    const FString& FileName,
    FText* OutFailReason
)

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)

Public function Const

bool

 

UpdatePluginFile

(
    const FString& FileName,
    FText& OutFailReason
)

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)

Public function Const

void

 

Write

(
    FString& Text
)

Writes a descriptor to JSON

Public function Const

void

 

Write

(
    TJsonWriter<>& Writer
)

Writes a descriptor to JSON