Navigation
Unreal Engine C++ API Reference > Runtime > Projects
References
Module | Projects |
Header | /Engine/Source/Runtime/Projects/Public/PluginReferenceDescriptor.h |
Include | #include "PluginReferenceDescriptor.h" |
Syntax
struct FPluginReferenceDescriptor
Remarks
Descriptor for a plugin reference. Contains the information required to enable or disable a plugin for a given platform.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
TMap< FString, TSharedPtr< FJsonValue > > | AdditionalFieldsToWrite | Additional fields to write |
![]() |
bool | bEnabled | Whether it should be enabled by default |
![]() |
bool | bHasExplicitPlatforms | When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions |
![]() |
bool | bOptional | Whether this plugin is optional, and the game should silently ignore it not being present |
![]() |
TSharedPtr< FJsonObject > | CachedJson | Cached json for custom data |
![]() |
FString | Description | Description of the plugin for users that do not have it installed. |
![]() |
FString | MarketplaceURL | URL for this plugin on the marketplace, if the user doesn't have it installed. |
![]() |
FString | Name | Name of the plugin |
![]() |
TArray< FString > | PlatformAllowList | If enabled, list of platforms for which the plugin should be enabled (or all platforms if blank). |
![]() |
TArray< FString > | PlatformDenyList | If enabled, list of platforms for which the plugin should be disabled. |
![]() |
TOptional< int32 > | RequestedVersion | When set, specifies a specific version of the plugin that this references. |
![]() |
TArray< FString > | SupportedTargetPlatforms | The list of supported target platforms for this plugin. |
![]() |
TArray< EBuildTargetType > | TargetAllowList | If enabled, list of targets for which the plugin should be enabled (or all targets if blank). |
![]() |
TArray< EBuildConfiguration > | TargetConfigurationAllowList | If enabled, list of target configurations for which the plugin should be enabled (or all target configurations if blank). |
![]() |
TArray< EBuildConfiguration > | TargetConfigurationDenyList | If enabled, list of target configurations for which the plugin should be disabled. |
![]() |
TArray< EBuildTargetType > | TargetDenyList | If enabled, list of targets for which the plugin should be disabled. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FPluginReferenceDescriptor
(
const FString& InName, |
Constructor |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
bool | GetAdditionalStringField
(
const FString& Key, |
Gets the string value for a given key by first looking into AdditionalFieldsToWrite and then CachedJson |
![]() ![]() |
bool | IsEnabledForPlatform
(
const FString& Platform |
Determines whether the plugin is enabled for the given platform |
![]() ![]() |
bool | IsEnabledForTarget
(
EBuildTargetType TargetType |
Determines whether the plugin is enabled for the given target |
![]() ![]() |
bool | IsEnabledForTargetConfiguration
(
EBuildConfiguration Configuration |
Determines whether the plugin is enabled for the given target configuration |
![]() ![]() |
bool | IsSupportedTargetPlatform
(
const FString& Platform |
Determines if the referenced plugin is supported for the given platform |
![]() |
bool | Read
(
const TSharedRef< FJsonObject >& Object, |
Reads the descriptor from the given JSON object |
![]() |
bool | Read
(
const FJsonObject& Object, |
|
![]() |
bool | Read
(
const FJsonObject& Object, |
|
![]() ![]() |
bool | ReadArray
(
const FJsonObject& Object, |
Reads an array of modules from the given JSON object |
![]() ![]() |
bool | ReadArray
(
const FJsonObject& Object, |
Reads an array of modules from the given JSON object |
![]() ![]() |
void | UpdateArray
(
FJsonObject& JsonObject, |
Updates an array of plugin references in the specified JSON field (indexed by plugin name) |
![]() ![]() |
void | UpdateJson
(
FJsonObject& JsonObject |
Updates the given json object with values in this descriptor |
![]() ![]() |
void | Write
(
TJsonWriter<>& Writer |
Writes a descriptor to JSON |
![]() ![]() |
void | WriteArray
(
TJsonWriter<>& Writer, |
Writes an array of plugin references to JSON |