1. Epic GamesDeveloper
  3. FPluginUtils

FPluginUtils

API > API/Plugins > API/Plugins/PluginUtils

   
Name FPluginUtils
Type class
Header File /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h
Include Path #include "PluginUtils.h"

Syntax

class FPluginUtils

Structs

Name Remarks
FLoadPluginParams Parameters for loading/mounting a plugin
FMountPluginParams Parameters for mounting a plugin.
FNewPluginParams Parameters for creating a new plugin.
FNewPluginParamsWithDescriptor Parameters for creating a new plugin.

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddToPluginSearchPathIfNeeded ( const FString& Dir,
bool bRefreshPlugins,
bool bUpdateProjectFile
)

 Adds a directory to the list of paths that are recursively searched for plugins, if that directory isn't already under the search paths. PluginUtils.h  

static TSharedPtr< IPlugin > CreateAndLoadNewPlugin ( const FString& PluginName,
const FString& NameToReplace,
const FString& PluginLocation,
const FNewPluginParamsWithDescriptor& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin PluginUtils.h  

static TSharedPtr< IPlugin > CreateAndLoadNewPlugin ( const FString& PluginFilePath,
const FNewPluginParams& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin PluginUtils.h  

static TSharedPtr< IPlugin > CreateAndLoadNewPlugin ( const FString& PluginFilePath,
const FNewPluginParamsWithDescriptor& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin PluginUtils.h  

static TSharedPtr< IPlugin > CreateAndLoadNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParams& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin PluginUtils.h  

static TSharedPtr< IPlugin > CreateAndLoadNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParamsWithDescriptor& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin PluginUtils.h  

static PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< IPlugin > CreateAndMountNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParamsWithDescriptor& CreationParams,
const FMountPluginParams& MountParams,
FText& FailReason
)

 Helper to create and mount a new plugin. Will fail if the plugin already exists PluginUtils.h  

static PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< IPlugin > CreateAndMountNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParams& CreationParams,
const FMountPluginParams& MountParams,
FText& FailReason
)

 Helper to create and mount a new plugin. Will fail if the plugin already exists PluginUtils.h  

static TSharedPtr< IPlugin > FindLoadedPlugin ( const FString& PluginDescriptorFileName
)

 Finds a loaded plugin from a plugin descriptor file path PluginUtils.h  

static TSharedPtr< IPlugin > FindPluginFromPackagePath ( FStringView PackagePath
)

   PluginUtils.h  
Finds the plugin that contains the specified package, if any PluginUtils.h  

static FString GetPluginContentFolder ( const FString& PluginLocation,
const FString& PluginName,
bool bFullPath
)

 Returns the plugin Content folder. PluginUtils.h  

static FString GetPluginContentFolder ( const FString& PluginFilePath,
bool bFullPath
)

 Returns the plugin Content folder from its uplugin file path. PluginUtils.h  

static FString GetPluginFilePath ( const FString& PluginLocation,
const FString& PluginName,
bool bFullPath
)

 Returns the uplugin file path. PluginUtils.h  

static FString GetPluginFolder ( const FString& PluginFilePath,
bool bFullPath
)

 Returns the plugin folder from its uplugin file path. PluginUtils.h  

static FString GetPluginFolder ( const FString& PluginLocation,
const FString& PluginName,
bool bFullPath
)

 Returns the plugin folder. PluginUtils.h  

static FString GetPluginName ( const FString& PluginFilePath
)

 Returns the plugin name from its uplugin file path. PluginUtils.h  

static FString GetPluginResourcesFolder ( const FString& PluginLocation,
const FString& PluginName,
bool bFullPath
)

 Returns the plugin Resources folder. PluginUtils.h  

static FString GetPluginResourcesFolder ( const FString& PluginFilePath,
bool bFullPath
)

 Returns the plugin Resources folder from its uplugin file path. PluginUtils.h  

static bool IsValidPluginName ( const FString& PluginName,
FText* FailReason,
const FText* PluginTermReplacement
)

 Returns whether the specified plugin name is valid, regardless of whether it's already used PluginUtils.h  

static TSharedPtr< IPlugin > LoadPlugin ( const FString& PluginName,
const FString& PluginLocation,
FLoadPluginParams& LoadParams
)

 Load/mount the specified plugin PluginUtils.h  

static TSharedPtr< IPlugin > LoadPlugin ( const FString& PluginFilePath,
FLoadPluginParams& LoadParams
)

 Load/mount the specified plugin PluginUtils.h  

static TSharedPtr< IPlugin > LoadPlugin ( const FString& PluginFilePath
)

 Load/mount the specified plugin PluginUtils.h  

static TSharedPtr< IPlugin > LoadPlugin ( const FString& PluginName,
const FString& PluginLocation
)

 Load/mount the specified plugin PluginUtils.h  

static PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< IPlugin > MountPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FMountPluginParams& MountParams,
FText& FailReason
)

 Load/mount the specified plugin. PluginUtils.h  

static bool UnloadPlugin ( const TSharedRef< IPlugin >& Plugin,
FText* OutFailReason
)

 Unload assets from the specified plugin and unmount it PluginUtils.h  

static bool UnloadPlugin ( const FString& PluginName,
FText* OutFailReason
)

 Unload assets from the specified plugin and unmount it PluginUtils.h  

static bool UnloadPluginAssets ( const TSharedRef< IPlugin >& Plugin,
FText* OutFailReason
)

 Unload assets from the specified plugin but does not unmount it PluginUtils.h  

static bool UnloadPluginAssets ( const FString& PluginName,
FText* OutFailReason
)

 Unload assets from the specified plugin but does not unmount it PluginUtils.h  

static bool UnloadPlugins ( const TConstArrayView< FString > PluginNames,
FText* OutFailReason
)

 Unload assets from the specified plugins and unmount them PluginUtils.h  

static bool UnloadPlugins ( const TConstArrayView< TSharedRef< IPlugin > > Plugins,
FText* OutFailReason
)

 Unload assets from the specified plugins and unmount them PluginUtils.h  

static bool UnloadPluginsAssets ( const TConstArrayView< TSharedRef< IPlugin > > Plugins,
FText* OutFailReason
)

 Unload assets from the specified plugins but does not unmount them PluginUtils.h  

static bool UnloadPluginsAssets ( const TConstArrayView< FString > PluginNames,
FText* OutFailReason
)

 Unload assets from the specified plugin but does not unmount them PluginUtils.h  

static bool UnloadPluginsAssets ( const TSet< FString >& PluginNames,
FText* OutFailReason
)

 Unload assets from the specified plugin but does not unmount them PluginUtils.h  

static bool ValidateNewPluginFilePath ( const FString& PluginFilePath,
FText* FailReason
)

 Validate that the plugin name is valid, that the name isn't already used by a registered plugin and optionally that there isn't an unregistered plugin with that name that exists at the plugin folder PluginUtils.h  

static bool ValidateNewPluginNameAndLocation ( const FString& PluginName,
const FString& PluginLocation,
FText* FailReason
)

 Validate that the plugin name is valid, that the name isn't already used by a registered plugin and optionally that there isn't an unregistered plugin with that name that exists at the specified location. PluginUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page