Navigation
API > API/Runtime > API/Runtime/Projects
Information about an enabled plugin.
| Name | IPlugin |
| Type | class |
| Header File | /Engine/Source/Runtime/Projects/Public/Interfaces/IPluginManager.h |
| Include Path | #include "Interfaces/IPluginManager.h" |
Syntax
class IPlugin : public TSharedFromThis< IPlugin >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IPlugin
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPlugin() |
Virtual destructor | Interfaces/IPluginManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanContainContent() |
Determines if the plugin can contain content. | Interfaces/IPluginManager.h | |
bool CanContainVerse() |
Determines if the plugin can contain Verse code. | Interfaces/IPluginManager.h | |
FString GetBaseDir() |
Get a filesystem path to the plugin's directory. | Interfaces/IPluginManager.h | |
FString GetContentDir() |
Get a filesystem path to the plugin's content directory. | Interfaces/IPluginManager.h | |
const FString & GetDeprecatedEngineVersion () |
Gets the engine version that this plugin was deprecated. | Interfaces/IPluginManager.h | |
const FPluginDescriptor & GetDescriptor() |
Gets the plugin's descriptor | Interfaces/IPluginManager.h | |
const FString & GetDescriptorFileName() |
Get a filesystem path to the plugin's descriptor | Interfaces/IPluginManager.h | |
const TSharedPtr< FJsonObject > & GetDescriptorJson() |
Gets the cached plugin descriptor json | Interfaces/IPluginManager.h | |
| Get a filesystem path to the plugin's directory. | Interfaces/IPluginManager.h | ||
const FString & GetFriendlyName() |
Return plugin friendly name if available or the same name as GetName() otherwise. | Interfaces/IPluginManager.h | |
EPluginLoadedFrom GetLoadedFrom() |
Returns the plugin's location | Interfaces/IPluginManager.h | |
FString GetMountedAssetPath() |
Get the virtual root path for assets. | Interfaces/IPluginManager.h | |
const FString & GetName() |
Gets the plugin name. | Interfaces/IPluginManager.h | |
EPluginType GetType() |
Gets the type of a plugin | Interfaces/IPluginManager.h | |
const FString & GetVersePath() |
Gets the Verse path to the root of the plugin's content directory | Interfaces/IPluginManager.h | |
TOptional< uint32 > GetVerseVersion() |
Return the Verse language version to compile the plugin with (if unspecified, the latest stable version is used) | Interfaces/IPluginManager.h | |
bool IsEnabled() |
Determines if the plugin is enabled. | Interfaces/IPluginManager.h | |
bool IsEnabledByDefault
(
bool bAllowEnginePluginsEnabledByDefault |
Determines if the plugin is enabled by default. | Interfaces/IPluginManager.h | |
bool IsHidden() |
Determines if the plugin is should be displayed in-editor for the user to enable/disable freely. | Interfaces/IPluginManager.h | |
bool IsMounted() |
Determines if the plugin is mounted. | Interfaces/IPluginManager.h | |
bool IsSceneGraphEnabled() |
Return whether Scene Graph is enabled or not. This impacts which Verse asset digest is generated. | Interfaces/IPluginManager.h | |
bool UpdateDescriptor
(
const FPluginDescriptor& NewDescriptor, |
Updates the plugin's descriptor | Interfaces/IPluginManager.h |