unreal.PluginBlueprintLibrary

class unreal.PluginBlueprintLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

A function library of utilities for querying information about plugins.

C++ Source:

• Module: Engine

• File: PluginBlueprintLibrary.h

classmethod get_additional_plugin_search_paths() → Array[str]

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.

Return type:

Array[str]

classmethod get_additional_project_plugin_search_paths() → Array[str]

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

Returns:

The additional project filesystem plugin search paths.

Return type:

Array[str]

classmethod get_enabled_plugin_names() → Array[str]

Get the names of all enabled plugins.

Returns:

The names of all enabled plugins.

Return type:

Array[str]

classmethod get_plugin_base_dir(plugin_name) → str or None

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

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_base_dir (str): Filesystem path to the plugin’s base directory, if found

Return type:

str or None

classmethod get_plugin_content_dir(plugin_name) → str or None

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

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_content_dir (str): Filesystem path to the plugin’s content directory, if found

Return type:

str or None

classmethod get_plugin_description(plugin_name) → str or None

Get the description of a plugin.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_description (str): Description of the plugin, if found

Return type:

str or None

classmethod get_plugin_descriptor_file_path(plugin_name) → str or None

Get the filesystem path to a plugin’s descriptor.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_file_path (str): Filesystem path to the plugin’s descriptor, if found

Return type:

str or None

classmethod get_plugin_editor_custom_virtual_path(plugin_name) → str or None

Get the editor custom virtual path of a plugin.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_virtual_path (str): Editor custom virtual path of the plugin, if found

Return type:

str or None

classmethod get_plugin_mounted_asset_path(plugin_name) → str or None

Get the virtual root path for assets in a plugin.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_asset_path (str): Virtual root path for the plugin’s assets, if found

Return type:

str or None

classmethod get_plugin_name_for_object_path(object_path) → str or None

Get the name of the plugin containing an object.

Parameters:

object_path (SoftObjectPath) – Path to the object

Returns:

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

out_plugin_name (str): Name of the plugin containing the object, if found

Return type:

str or None

classmethod get_plugin_version(plugin_name) → int32 or None

Get the version number of a plugin.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_version (int32): Version number of the plugin, if found

Return type:

int32 or None

classmethod get_plugin_version_name(plugin_name) → str or None

Get the version name of a plugin.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

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

out_version_name (str): Version name of the plugin, if found

Return type:

str or None

classmethod is_plugin_mounted(plugin_name) → bool

Determine whether a plugin is mounted.

Parameters:

plugin_name (str) – Name of the plugin

Returns:

true if the named plugin is mounted, or false otherwise

Return type:

bool