Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > PluginUtils > FPluginUtils

Light Theme

Dark Theme

FPluginUtils

Windows

MacOS

Linux

References

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

Syntax

class FPluginUtils

Functions

	Name	Description
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.
TSharedPtr< ...	CreateAndMountNewPlugin ( const FString& PluginName, const FString& PluginLocation, const FNewPluginParams& CreationPa..., const FMountPluginParams& MountPar..., FText& FailReason )	Helper to create and mount a new plugin.
FString	GetPluginContentFolder ( const FString& PluginLocation, const FString& PluginName, bool bFullPath )	Returns the plugin Content folder.
FString	GetPluginFilePath ( const FString& PluginLocation, const FString& PluginName, bool bFullPath )	Returns the uplugin file path.
FString	GetPluginFolder ( const FString& PluginLocation, const FString& PluginName, bool bFullPath )	Returns the plugin folder.
FString	GetPluginResourcesFolder ( const FString& PluginLocation, const FString& PluginName, bool bFullPath )	Returns the plugin Resources folder.
bool	IsValidPluginName ( const FString& PluginName, FText* FailReason )	Returns whether the specified plugin name is valid, regardless of whether it's already used
TSharedPtr< ...	MountPlugin ( const FString& PluginName, const FString& PluginLocation, const FMountPluginParams& MountPar..., FText& FailReason )	Load/mount the specified plugin.
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

	Name	Description
	FMountPluginParams	Parameters for mounting a plugin.
	FNewPluginParams	Parameters for creating a new plugin.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss