FPluginReferenceDescriptor

Descriptor for a plugin reference.

Choose your operating system:

Windows

macOS

Linux

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

	Name	Description
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
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.
TArray< FString...	SupportedTargetPlatforms	The list of supported target platforms for this plugin.
TArray< EBuildT...	TargetAllowList	If enabled, list of targets for which the plugin should be enabled (or all targets if blank).
TArray< EBuildC...	TargetConfigurationAllowList	If enabled, list of target configurations for which the plugin should be enabled (or all target configurations if blank).
TArray< EBuildC...	TargetConfigurationDenyList	If enabled, list of target configurations for which the plugin should be disabled.
TArray< EBuildT...	TargetDenyList	If enabled, list of targets for which the plugin should be disabled.

Constructors

	Name	Description
	FPluginReferenceDescriptor ( const FString& InName, bool bInEnabled )	Constructor

Functions

	Name	Description
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 FJsonObject& Object, FText* OutFailReason )	Reads the descriptor from the given JSON object
bool	Read ( const FJsonObject& Object, FText& OutFailReason )	Reads the descriptor from the given JSON object
bool	ReadArray ( const FJsonObject& Object, const TCHAR* Name, TArray< FPluginReferenceDescriptor ..., FText* OutFailReason )	Reads an array of modules from the given JSON object
bool	ReadArray ( const FJsonObject& Object, const TCHAR* Name, TArray< FPluginReferenceDescriptor ..., FText& OutFailReason )	Reads an array of modules from the given JSON object
void	UpdateArray ( FJsonObject& JsonObject, const TCHAR* ArrayName, const TArray< FPluginReferenceDescr... )	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, const TCHAR* ArrayName, const TArray< FPluginReferenceDescr... )	Writes an array of plugin references to JSON