FPluginReferenceDescriptor

Descriptor for a plugin reference.

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

Public variable

bool

 

bEnabled

Whether it should be enabled by default

Public variable

TArray < FString ...

 

BlacklistPlatforms

If enabled, list of platforms for which the plugin should be disabled.

Public variable

TArray < EBuildC ...

 

BlacklistTargetConfigurations

If enabled, list of target configurations for which the plugin should be disabled.

Public variable

TArray < EBuildT ...

 

BlacklistTargets

If enabled, list of targets for which the plugin should be disabled.

Public variable

bool

 

bOptional

Whether this plugin is optional, and the game should silently ignore it not being present

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 ...

 

SupportedTargetPlatforms

The list of supported target platforms for this plugin.

Public variable

TArray < FString ...

 

WhitelistPlatforms

If enabled, list of platforms for which the plugin should be enabled (or all platforms if blank).

Public variable

TArray < EBuildC ...

 

WhitelistTargetConfigurations

If enabled, list of target configurations for which the plugin should be enabled (or all target configurations if blank).

Public variable

TArray < EBuildT ...

 

WhitelistTargets

If enabled, list of targets for which the plugin should be enabled (or all targets if blank).

Constructors

Name Description

Public function

FPluginReferenceDescriptor

(
    const FString & InName,
    bool bInEnabled
)

Constructor

Functions

Name Description

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 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 ...,
    FText & OutFailReason
)

Reads an array of modules from the given JSON object

Public function Const

void

 

Write

(
    TJsonWriter<>& Writer
)

Writes a descriptor to JSON

Public function Static

void

 

WriteArray

(
    TJsonWriter<>& Writer,
    const TCHAR * Name,
    const TArray < FPluginReferenceDescr ...
)

Writes an array of modules to JSON

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback