Plugin Namespace Reference

Functions
Engine Scripting | Plugin Utilities
bool	GetPluginDescriptorFilePath (FString PluginName, FString &OutFilePath)
	Get the filesystem path to a plugin's descriptor.
const TArray< FString > &	GetAdditionalProjectPluginSearchPaths ()
	Get the list of extra directories added by the project that are recursively searched for plugins.
TArray< FString >	GetEnabledPluginNames ()
	Get the names of all enabled plugins.
bool	GetPluginBaseDir (FString PluginName, FString &OutBaseDir)
	Get the filesystem path to a plugin's base directory.
bool	GetPluginContentDir (FString PluginName, FString &OutContentDir)
	Get the filesystem path to a plugin's content directory.
bool	GetPluginDescription (FString PluginName, FString &OutDescription)
	Get the description of a plugin.
TArray< FString >	GetAdditionalPluginSearchPaths ()
	Get the list of extra directories that are recursively searched for plugins (aside from the engine and project plugin directories).
bool	GetPluginEditorCustomVirtualPath (FString PluginName, FString &OutVirtualPath)
	Get the editor custom virtual path of a plugin.
bool	GetPluginMountedAssetPath (FString PluginName, FString &OutAssetPath)
	Get the virtual root path for assets in a plugin.
bool	GetPluginNameForObjectPath (FSoftObjectPath ObjectPath, FString &OutPluginName)
	Get the name of the plugin containing an object.
bool	GetPluginVersion (FString PluginName, int &OutVersion)
	Get the version number of a plugin.
bool	GetPluginVersionName (FString PluginName, FString &OutVersionName)
	Get the version name of a plugin.
bool	IsPluginMounted (FString PluginName)
	Determine whether a plugin is mounted.

Variables
Variables
const TArray< FString >	AdditionalProjectPluginSearchPaths
const TArray< FString >	EnabledPluginNames
const TArray< FString >	AdditionalPluginSearchPaths

Function Documentation

GetAdditionalPluginSearchPaths()

TArray< FString > GetAdditionalPluginSearchPaths

(

)

Get the list of extra directories that are recursively searched for plugins (aside from the engine and project plugin directories).

Returns

The additional filesystem plugin search paths.

GetAdditionalProjectPluginSearchPaths()

const TArray< FString > & GetAdditionalProjectPluginSearchPaths

(

)

Get the list of extra directories added by the project that are recursively searched for plugins.

Returns

The additional project filesystem plugin search paths.

GetEnabledPluginNames()

TArray< FString > GetEnabledPluginNames

(

)

Get the names of all enabled plugins.

Returns

The names of all enabled plugins.

GetPluginBaseDir()

bool GetPluginBaseDir	(	FString	PluginName,
		FString &	OutBaseDir )

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

Parameters

PluginName	Name of the plugin
OutBaseDir	Filesystem path to the plugin's base directory, if found

Returns

true if the named plugin was found and the plugin base directory filesystem path was stored in OutBaseDir, or false otherwise

GetPluginContentDir()

bool GetPluginContentDir	(	FString	PluginName,
		FString &	OutContentDir )

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

Parameters

PluginName	Name of the plugin
OutContentDir	Filesystem path to the plugin's content directory, if found

Returns

true if the named plugin was found and the plugin content directory filesystem path was stored in OutContentDir, or false otherwise

GetPluginDescription()

bool GetPluginDescription	(	FString	PluginName,
		FString &	OutDescription )

Get the description of a plugin.

Parameters

PluginName	Name of the plugin
OutDescription	Description of the plugin, if found

Returns

true if the named plugin was found and the plugin's description was stored in OutDescription, or false otherwise

GetPluginDescriptorFilePath()

bool GetPluginDescriptorFilePath	(	FString	PluginName,
		FString &	OutFilePath )

Get the filesystem path to a plugin's descriptor.

Parameters

PluginName	Name of the plugin
OutFilePath	Filesystem path to the plugin's descriptor, if found

Returns

true if the named plugin was found and the plugin descriptor filesystem path was stored in OutFilePath, or false otherwise

GetPluginEditorCustomVirtualPath()

bool GetPluginEditorCustomVirtualPath	(	FString	PluginName,
		FString &	OutVirtualPath )

Get the editor custom virtual path of a plugin.

Parameters

PluginName	Name of the plugin
OutVirtualPath	Editor custom virtual path of the plugin, if found

Returns

true if the named plugin was found and the plugin's editor custom virtual path was stored in OutVirtualPath, or false otherwise

GetPluginMountedAssetPath()

bool GetPluginMountedAssetPath	(	FString	PluginName,
		FString &	OutAssetPath )

Get the virtual root path for assets in a plugin.

Parameters

PluginName	Name of the plugin
OutAssetPath	Virtual root path for the plugin's assets, if found

Returns

true if the named plugin was found and the plugin's virtual root path was stored in OutAssetPath, or false otherwise

GetPluginNameForObjectPath()

bool GetPluginNameForObjectPath	(	FSoftObjectPath	ObjectPath,
		FString &	OutPluginName )

Get the name of the plugin containing an object.

Parameters

ObjectPath	Path to the object
OutPluginName	Name of the plugin containing the object, if found

Returns

true if the object is contained within a plugin and the plugin name was stored in OutPluginName, or false otherwise

GetPluginVersion()

bool GetPluginVersion	(	FString	PluginName,
		int &	OutVersion )

Get the version number of a plugin.

Parameters

PluginName	Name of the plugin
OutVersion	Version number of the plugin, if found

Returns

true if the named plugin was found and the plugin's version number was stored in OutVersion, or false otherwise

GetPluginVersionName()

bool GetPluginVersionName	(	FString	PluginName,
		FString &	OutVersionName )

Get the version name of a plugin.

Parameters

PluginName	Name of the plugin
OutVersionName	Version name of the plugin, if found

Returns

true if the named plugin was found and the plugin's version name was stored in OutVersionName, or false otherwise

IsPluginMounted()

bool IsPluginMounted

(

FString

PluginName

)

Determine whether a plugin is mounted.

Parameters

PluginName

Name of the plugin

Returns

true if the named plugin is mounted, or false otherwise

Variable Documentation

AdditionalPluginSearchPaths

const TArray<FString> AdditionalPluginSearchPaths

AdditionalProjectPluginSearchPaths

const TArray<FString> AdditionalProjectPluginSearchPaths

EnabledPluginNames

const TArray<FString> EnabledPluginNames