IPlugin Class Reference

#include <IPluginManager.h>

Inheritance diagram for IPlugin:

Public Member Functions
virtual	~IPlugin ()
virtual const FString &	GetName () const =0
virtual const FString &	GetFriendlyName () const =0
virtual const FString &	GetDescriptorFileName () const =0
virtual FString	GetBaseDir () const =0
virtual TArray< FString >	GetExtensionBaseDirs () const =0
virtual FString	GetContentDir () const =0
virtual FString	GetMountedAssetPath () const =0
virtual EPluginType	GetType () const =0
virtual bool	IsEnabled () const =0
virtual bool	IsEnabledByDefault (bool bAllowEnginePluginsEnabledByDefault) const =0
virtual bool	IsMounted () const =0
virtual bool	IsHidden () const =0
virtual bool	CanContainContent () const =0
virtual bool	CanContainVerse () const =0
virtual const FString &	GetVersePath () const =0
virtual const FString &	GetDeprecatedEngineVersion () const =0
virtual TOptional< uint32 >	GetVerseVersion () const =0
virtual bool	IsSceneGraphEnabled () const =0
virtual EPluginLoadedFrom	GetLoadedFrom () const =0
virtual const FPluginDescriptor &	GetDescriptor () const =0
virtual bool	UpdateDescriptor (const FPluginDescriptor &NewDescriptor, FText &OutFailReason)=0
Public Member Functions inherited from TSharedFromThis< IPlugin >
TSharedRef< IPlugin, Mode >	AsShared ()
TSharedRef< IPlugin const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< IPlugin, Mode >	AsWeak ()
TWeakPtr< IPlugin const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< IPlugin >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< IPlugin >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Information about an enabled plugin.

Constructor & Destructor Documentation

~IPlugin()

virtual IPlugin::~IPlugin ( )

inlinevirtual

Member Function Documentation

CanContainContent()

virtual bool IPlugin::CanContainContent ( ) const

pure virtual

Determines if the plugin can contain content.

Returns

True if the plugin can contain content.

Implemented in FPlugin.

CanContainVerse()

virtual bool IPlugin::CanContainVerse ( ) const

pure virtual

Determines if the plugin can contain Verse code.

Returns

True if the plugin can contain Verse code.

Implemented in FPlugin.

GetBaseDir()

virtual FString IPlugin::GetBaseDir ( ) const

pure virtual

Get a filesystem path to the plugin's directory.

Returns

Filesystem path to the plugin's base directory.

Implemented in FPlugin.

GetContentDir()

virtual FString IPlugin::GetContentDir ( ) const

pure virtual

Get a filesystem path to the plugin's content directory.

Returns

Filesystem path to the plugin's content directory.

Implemented in FPlugin.

GetDeprecatedEngineVersion()

virtual const FString & IPlugin::GetDeprecatedEngineVersion ( ) const

pure virtual

Gets the engine version that this plugin was deprecated. If unset then this plugin is not deprecated.

Returns

Deprecated engine version. This may be an empty string.

Implemented in FPlugin.

GetDescriptor()

virtual const FPluginDescriptor & IPlugin::GetDescriptor ( ) const

pure virtual

Gets the plugin's descriptor

Returns

Reference to the plugin's descriptor

Implemented in FPlugin.

GetDescriptorFileName()

virtual const FString & IPlugin::GetDescriptorFileName ( ) const

pure virtual

Get a filesystem path to the plugin's descriptor

Returns

Filesystem path to the plugin's descriptor.

Implemented in FPlugin.

GetExtensionBaseDirs()

virtual TArray< FString > IPlugin::GetExtensionBaseDirs ( ) const

pure virtual

Get a filesystem path to the plugin's directory.

Returns

Filesystem path to the plugin's base directory.

Implemented in FPlugin.

GetFriendlyName()

virtual const FString & IPlugin::GetFriendlyName ( ) const

pure virtual

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

Implemented in FPlugin.

GetLoadedFrom()

virtual EPluginLoadedFrom IPlugin::GetLoadedFrom ( ) const

pure virtual

Returns the plugin's location

Returns

Where the plugin was loaded from

Implemented in FPlugin.

GetMountedAssetPath()

virtual FString IPlugin::GetMountedAssetPath ( ) const

pure virtual

Get the virtual root path for assets.

Returns

The mounted root path for assets in this plugin's content folder; typically /PluginName/.

Implemented in FPlugin.

GetName()

virtual const FString & IPlugin::GetName ( ) const

pure virtual

Gets the plugin name.

Returns

Name of the plugin.

Implemented in FPlugin.

GetType()

virtual EPluginType IPlugin::GetType ( ) const

pure virtual

Gets the type of a plugin

Returns

The plugin type

Implemented in FPlugin.

GetVersePath()

virtual const FString & IPlugin::GetVersePath ( ) const

pure virtual

Gets the Verse path to the root of the plugin's content directory

Returns

Verse path to the root of the plugin's content directory

Implemented in FPlugin.

GetVerseVersion()

virtual TOptional< uint32 > IPlugin::GetVerseVersion ( ) const

pure virtual

Return the Verse language version to compile the plugin with (if unspecified, the latest stable version is used)

Implemented in FPlugin.

IsEnabled()

virtual bool IPlugin::IsEnabled ( ) const

pure virtual

Determines if the plugin is enabled.

Returns

True if the plugin is currently enabled.

Implemented in FPlugin.

IsEnabledByDefault()

virtual bool IPlugin::IsEnabledByDefault ( bool  bAllowEnginePluginsEnabledByDefault ) const

pure virtual

Determines if the plugin is enabled by default.

Returns

True if the plugin is currently enabled by default.

Implemented in FPlugin.

IsHidden()

virtual bool IPlugin::IsHidden ( ) const

pure virtual

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

Returns

True if the plugin should be hidden.

Implemented in FPlugin.

IsMounted()

virtual bool IPlugin::IsMounted ( ) const

pure virtual

Determines if the plugin is mounted.

Returns

True if the plugin is currently mounted.

Implemented in FPlugin.

IsSceneGraphEnabled()

virtual bool IPlugin::IsSceneGraphEnabled ( ) const

pure virtual

Return whether Scene Graph is enabled or not. This impacts which Verse asset digest is generated.

Implemented in FPlugin.

UpdateDescriptor()

virtual bool IPlugin::UpdateDescriptor ( const FPluginDescriptor &  NewDescriptor, FText &  OutFailReason  )

pure virtual

Updates the plugin's descriptor

Parameters

NewDescriptor	The new plugin descriptor
OutFailReason	The error message if the plugin's descriptor could not be updated

Returns

True if the descriptor was updated, false otherwise.

Implemented in FPlugin.

---

The documentation for this class was generated from the following file:

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