Navigation
API > API/Runtime > API/Runtime/Projects > API/Runtime/Projects/Interfaces
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- IPlugin
References
| Module | Projects |
| Header | /Engine/Source/Runtime/Projects/Public/Interfaces/IPluginManager.h |
| Include | #include "Interfaces/IPluginManager.h" |
Syntax
class IPlugin : public TSharedFromThis< IPlugin >
Remarks
Information about an enabled plugin.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
~IPlugin () |
Virtual destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Determines if the plugin can contain content. | |
  |
bool | Determines if the plugin can contain Verse code. | |
  |
FString | GetBaseDir () |
Get a filesystem path to the plugin's directory. |
  |
FString | Get a filesystem path to the plugin's content directory. | |
  |
const FPluginDescriptor & | Gets the plugin's descriptor | |
  |
const FString & | Get a filesystem path to the plugin's descriptor | |
 |
const TSharedPtr< FJsonObject > & | Gets the cached plugin descriptor json | |
  |
TArray< FString > | Get a filesystem path to the plugin's directory. | |
  |
const FString & | Return plugin friendly name if available or the same name as GetName() otherwise. | |
  |
EPluginLoadedFrom | Returns the plugin's location | |
  |
FString | Get the virtual root path for assets. | |
  |
const FString & | GetName () |
Gets the plugin name. |
  |
EPluginType | GetType () |
Gets the type of a plugin |
  |
const FString & | GetVersePath () |
Gets the Verse path to the root of the plugin's content directory |
  |
TOptional< uint32 > | Return the Verse language version to compile the plugin with (if unspecified, the latest stable version is used) | |
  |
bool | IsEnabled () |
Determines if the plugin is enabled. |
  |
bool | IsEnabledByDefault
(
bool bAllowEnginePluginsEnabledByDefault |
Determines if the plugin is enabled by default. |
  |
bool | IsHidden () |
Determines if the plugin is should be displayed in-editor for the user to enable/disable freely. |
 |
void | SetVersePath
(
FString&& InVersePath |
Sets the Verse path to the root of the plugin's content directory |
 |
void | SetVerseVersion
(
TOptional< uint32 > InVerseVersion |
Sets the Verse language version to compile the plugin with (if unspecified, the latest stable version is used) |
 |
bool | UpdateDescriptor
(
const FPluginDescriptor& NewDescriptor, |
Updates the plugin's descriptor |