1. Epic GamesDeveloper
  3. FPluginUtils

FPluginUtils

Unreal Engine C++ API Reference > Plugins > PluginUtils

References

   
Module PluginUtils
Header /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h
Include #include "PluginUtils.h"

Syntax

class FPluginUtils

Functions

  Type Name Description
Public function 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.
Public function Static TSharedPtr< IPlugin >

CreateAndLoadNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParamsWithDescriptor& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin
Public function Static TSharedPtr< IPlugin >

CreateAndLoadNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParams& CreationParams,
FLoadPluginParams& LoadParams
)

 Helper to create and load a new plugin
Public function Static TSharedPtr< IPlugin >

FindLoadedPlugin ( const FString& PluginDescriptorFileName
)

 Finds a loaded plugin from a plugin descriptor file path
Public function Static FString

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

 Returns the plugin Content folder.
Public function Static FString

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

 Returns the uplugin file path.
Public function Static FString

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

 Returns the plugin folder.
Public function Static FString

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

 Returns the plugin Resources folder.
Public function 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
Public function Static TSharedPtr< IPlugin >

LoadPlugin ( const FString& PluginName,
const FString& PluginLocation,
FLoadPluginParams& LoadParams
)

 Load/mount the specified plugin
Public function Static TSharedPtr< IPlugin >

LoadPlugin ( const FString& PluginName,
const FString& PluginLocation
)

 Load/mount the specified plugin
Public function Static TSharedPtr< IPlugin >

LoadPlugin ( const FString& PluginFileName,
FLoadPluginParams& LoadParams
)

 Load/mount the specified plugin
Public function Static TSharedPtr< IPlugin >

LoadPlugin ( const FString& PluginFileName
)

 Load/mount the specified plugin
Public function Static bool

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

 Unload assets from the specified plugin and unmount it
Public function Static bool

UnloadPlugin ( const FString& PluginName,
FText* OutFailReason
)

 Unload assets from the specified plugin and unmount it
Public function Static bool

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

 Unload assets from the specified plugin but does not unmount it
Public function Static bool

UnloadPluginAssets ( const FString& PluginName,
FText* OutFailReason
)

 Unload assets from the specified plugin but does not unmount it
Public function Static bool

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

 Unload assets from the specified plugins and unmount them
Public function Static bool

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

 Unload assets from the specified plugins and unmount them
Public function Static bool

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

 Unload assets from the specified plugin but does not unmount them
Public function Static bool

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

 Unload assets from the specified plugins but does not unmount them
Public function Static bool

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

 Unload assets from the specified plugin but does not unmount them
Public function 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.

Classes

  Type Name Description
Public struct FLoadPluginParams Parameters for loading/mounting a plugin  
Public struct FMountPluginParams Parameters for mounting a plugin.  
Public struct FNewPluginParams Parameters for creating a new plugin.  
Public struct FNewPluginParamsWithDescriptor Parameters for creating a new plugin.  

Deprecated Functions

  Type Name Description
Public function Static PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< IPlugin >

CreateAndMountNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParams& CreationParams,
const FMountPluginParams& MountParams,
FText& FailReason
)

 CreateAndMountNewPlugin is deprecated; please use CreateAndLoadNewPlugin instead
Public function Static PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< IPlugin >

CreateAndMountNewPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FNewPluginParamsWithDescriptor& CreationParams,
const FMountPluginParams& MountParams,
FText& FailReason
)

 CreateAndMountNewPlugin is deprecated; please use CreateAndLoadNewPlugin instead
Public function Static PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< IPlugin >

MountPlugin ( const FString& PluginName,
const FString& PluginLocation,
const FMountPluginParams& MountParams,
FText& FailReason
)

 MountPlugin is deprecated; please use LoadPlugin instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page