1. Epic GamesDeveloper
  3. FPluginReferenceDescriptor

FPluginReferenceDescriptor

Descriptor for a plugin reference.

API > API/Runtime > API/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
Public variable TMap< FString, TSharedPtr< FJsonValue > > AdditionalFieldsToWrite Additional fields to write
Public variable bool bEnabled Whether it should be enabled by default
Public variable 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
Public variable bool bOptional Whether this plugin is optional, and the game should silently ignore it not being present
Public variable TSharedPtr< FJsonObject > CachedJson Cached json for custom data
Public variable FString Description Description of the plugin for users that do not have it installed.
Public variable FString MarketplaceURL URL for this plugin on the marketplace, if the user doesn't have it installed.
Public variable FString Name Name of the plugin
Public variable TArray< FString > PlatformAllowList If enabled, list of platforms for which the plugin should be enabled (or all platforms if blank).
Public variable TArray< FString > PlatformDenyList If enabled, list of platforms for which the plugin should be disabled.
Public variable TOptional< int32 > RequestedVersion When set, specifies a specific version of the plugin that this references.
Public variable TArray< FString > SupportedTargetPlatforms The list of supported target platforms for this plugin.
Public variable TArray< EBuildTargetType > TargetAllowList If enabled, list of targets for which the plugin should be enabled (or all targets if blank).
Public variable TArray< EBuildConfiguration > TargetConfigurationAllowList If enabled, list of target configurations for which the plugin should be enabled (or all target configurations if blank).
Public variable TArray< EBuildConfiguration > TargetConfigurationDenyList If enabled, list of target configurations for which the plugin should be disabled.
Public variable TArray< EBuildTargetType > TargetDenyList If enabled, list of targets for which the plugin should be disabled.

Constructors

  Type Name Description
Public function  

FPluginReferenceDescriptor ( const FString& InName,
bool bInEnabled
)

 Constructor

Functions

  Type Name Description
Public function Const bool

GetAdditionalStringField ( const FString& Key,
FString& OutValue
)

 Gets the string value for a given key by first looking into AdditionalFieldsToWrite and then CachedJson
Public function Const bool

IsEnabledForPlatform ( const FString& Platform
)

 Determines whether the plugin is enabled for the given platform
Public function Const bool

IsEnabledForTarget ( EBuildTargetType TargetType
)

 Determines whether the plugin is enabled for the given target
Public function Const bool

IsEnabledForTargetConfiguration ( EBuildConfiguration Configuration
)

 Determines whether the plugin is enabled for the given target configuration
Public function Const bool

IsSupportedTargetPlatform ( const FString& Platform
)

 Determines if the referenced plugin is supported for the given platform
Public function bool

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

 Reads the descriptor from the given JSON object
Public function Static bool

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

 Reads an array of modules from the given JSON object
Public function Static bool

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

 Reads an array of modules from the given JSON object
Public function 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)
Public function Const void

UpdateJson ( FJsonObject& JsonObject
)

 Updates the given json object with values in this descriptor
Public function Const void

Write ( TJsonWriter<>& Writer
)

 Writes a descriptor to JSON
Public function Static void

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

 Writes an array of plugin references to JSON

Deprecated Functions

  Type Name Description
Public function bool

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

 Use Read(const TSharedRef&) instead.
Public function bool

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

 Use Read(const TSharedRef&) instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page