IPlugin

Information about an enabled plugin.

Choose your operating system:

Windows

macOS

Linux

References

Module

Projects

Header

/Engine/Source/Runtime/Projects/Public/Interfaces/IPluginManager.h

Include

#include "Interfaces/IPluginManager.h"

Syntax

class IPlugin

Remarks

Information about an enabled plugin.

Destructors

Name Description

Public function Virtual

~IPlugin()

Virtual destructor

Functions

Name Description

Public function Const

bool

 

CanContainContent()

Determines if the plugin can contain content.

Public function Const

bool

 

CanContainVerse()

Determines if the plugin can contain Verse code.

Public function Const

FString

 

GetBaseDir()

Get a path to the plugin's directory.

Public function Const

FString

 

GetContentDir()

Get a path to the plugin's content directory.

Public function Const

const FPlugi...

 

GetDescriptor()

Gets the plugin's descriptor

Public function Const

const FStrin...

 

GetDescriptorFileName()

Get a path to the plugin's descriptor

Public function

const TShare...

 

GetDescriptorJson()

Gets the cached plugin descriptor json

Public function Const

const FStrin...

 

GetFriendlyName()

Return plugin friendly name if available or the same name as GetName() otherwise.

Public function Const

EPluginLoade...

 

GetLoadedFrom()

Returns the plugin's location

Public function Const

FString

 

GetMountedAssetPath()

Get the virtual root path for assets.

Public function Const

const FStrin...

 

GetName()

Gets the plugin name.

Public function Const

EPluginType

 

GetType()

Gets the type of a plugin

Public function Const

bool

 

IsEnabled()

Determines if the plugin is enabled.

Public function Const

bool

 

IsEnabledByDefault

(
    bool bAllowEnginePluginsEnabledByDe...
)

Determines if the plugin is enabled by default.

Public function Const

bool

 

IsHidden()

Determines if the plugin is should be displayed in-editor for the user to enable/disable freely.

Public function

bool

 

UpdateDescriptor

(
    const FPluginDescriptor& NewDescri...,
    FText& OutFailReason
)

Updates the plugin's descriptor