1. Epic GamesDeveloper
  3. FPluginReferenceDescriptor

FPluginReferenceDescriptor

Descriptor for a plugin reference.

API > API/Runtime > API/Runtime/Projects

Descriptor for a plugin reference. Contains the information required to enable or disable a plugin for a given platform.

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

Syntax

struct FPluginReferenceDescriptor

Constructors

Name Remarks Include Path Unreal Specifiers

FPluginReferenceDescriptor ( FString InName,
bool bInEnabled
)

 Constructor PluginReferenceDescriptor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalFieldsToWrite TMap< FString, TSharedPtr< FJsonValue > > Additional fields to write PluginReferenceDescriptor.h  
bActivate bool Whether this plugin dependency should also activate when the parent plugin is activated by the GameFeaturePlugin system. PluginReferenceDescriptor.h  
bEnabled bool Whether it should be enabled by default PluginReferenceDescriptor.h  
bHasExplicitPlatforms bool When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions PluginReferenceDescriptor.h  
bOptional bool Whether this plugin is optional, and the game should silently ignore it not being present PluginReferenceDescriptor.h  
CachedJson TSharedPtr< FJsonObject > Cached json for custom data PluginReferenceDescriptor.h  
Description FString Description of the plugin for users that do not have it installed. PluginReferenceDescriptor.h  
MarketplaceURL FString URL for this plugin on the marketplace, if the user doesn't have it installed. PluginReferenceDescriptor.h  
Name FString Name of the plugin PluginReferenceDescriptor.h  
PlatformAllowList TArray< FString > If enabled, list of platforms for which the plugin should be enabled (or all platforms if blank). PluginReferenceDescriptor.h  
PlatformDenyList TArray< FString > If enabled, list of platforms for which the plugin should be disabled. PluginReferenceDescriptor.h  
RequestedVersion TOptional< int32 > When set, specifies a specific version of the plugin that this references. PluginReferenceDescriptor.h  
SupportedTargetPlatforms TArray< FString > The list of supported target platforms for this plugin. PluginReferenceDescriptor.h  
TargetAllowList TArray< EBuildTargetType > If enabled, list of targets for which the plugin should be enabled (or all targets if blank). PluginReferenceDescriptor.h  
TargetConfigurationAllowList TArray< EBuildConfiguration > If enabled, list of target configurations for which the plugin should be enabled (or all target configurations if blank). PluginReferenceDescriptor.h  
TargetConfigurationDenyList TArray< EBuildConfiguration > If enabled, list of target configurations for which the plugin should be disabled. PluginReferenceDescriptor.h  
TargetDenyList TArray< EBuildTargetType > If enabled, list of targets for which the plugin should be disabled. PluginReferenceDescriptor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetAdditionalStringField ( const FString& Key,
FString& OutValue
) const

 Gets the string value for a given key by first looking into AdditionalFieldsToWrite and then CachedJson PluginReferenceDescriptor.h  

bool IsEnabledForPlatform ( const FString& Platform
) const

 Determines whether the plugin is enabled for the given platform PluginReferenceDescriptor.h  

bool IsEnabledForTarget ( EBuildTargetType TargetType
) const

 Determines whether the plugin is enabled for the given target PluginReferenceDescriptor.h  

bool IsEnabledForTargetConfiguration ( EBuildConfiguration Configuration
) const

 Determines whether the plugin is enabled for the given target configuration PluginReferenceDescriptor.h  

bool IsSupportedTargetPlatform ( const FString& Platform
) const

 Determines if the referenced plugin is supported for the given platform PluginReferenceDescriptor.h  

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

 Reads the descriptor from the given JSON object PluginReferenceDescriptor.h  

bool Read ( const FJsonObject& Object,
FText* OutFailReason,
TSharedPtr< FJsonObject > ObjectPtr
)

   PluginReferenceDescriptor.h  

bool Read ( const FJsonObject& Object,
FText& OutFailReason,
TSharedPtr< FJsonObject > ObjectPtr
)

   PluginReferenceDescriptor.h  

void UpdateJson ( FJsonObject& JsonObject
) const

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

void Write ( TJsonWriter<>& Writer
) const

 Writes a descriptor to JSON PluginReferenceDescriptor.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ReadArray ( const FJsonObject& Object,
const TCHAR* Name,
TArray< FPluginReferenceDescriptor >& OutModules,
FText* OutFailReason
)

 Reads an array of modules from the given JSON object PluginReferenceDescriptor.h  

static bool ReadArray ( const FJsonObject& Object,
const TCHAR* Name,
TArray< FPluginReferenceDescriptor >& OutModules,
FText& OutFailReason
)

 Reads an array of modules from the given JSON object PluginReferenceDescriptor.h  

static void UpdateArray ( FJsonObject& JsonObject,
const TCHAR* ArrayName,
const TArray< FPluginReferenceDescriptor >& Plugins
)

 Updates an array of plugin references in the specified JSON field (indexed by plugin name) PluginReferenceDescriptor.h  

static void WriteArray ( TJsonWriter<>& Writer,
const TCHAR* ArrayName,
const TArray< FPluginReferenceDescriptor >& Plugins
)

 Writes an array of plugin references to JSON PluginReferenceDescriptor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page