Navigation
API > API/Plugins > API/Plugins/PluginUtils > API/Plugins/PluginUtils/FPluginUtils
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< IPlugin > CreateAndLoadNewPlugin
(
const FString& PluginFilePath, |
Helper to create and load a new plugin | PluginUtils.h | |
static TSharedPtr< IPlugin > CreateAndLoadNewPlugin
(
const FString& PluginFilePath, |
Helper to create and load a new plugin | PluginUtils.h | |
static TSharedPtr< IPlugin > CreateAndLoadNewPlugin
(
const FString& PluginName, |
Helper to create and load a new plugin | PluginUtils.h | |
static TSharedPtr< IPlugin > CreateAndLoadNewPlugin
(
const FString& PluginName, |
Helper to create and load a new plugin | PluginUtils.h | |
static TSharedPtr< IPlugin > CreateAndLoadNewPlugin
(
const FString& PluginName, |
Helper to create and load a new plugin | PluginUtils.h |
CreateAndLoadNewPlugin(const FString &, const FNewPluginParams &, FLoadPluginParams &)
Description
Helper to create and load a new plugin
MountParams.OutFailReason outputs the reason the plugin creation or loading failed (if applicable)
Will fail if the plugin already exists
This function can circumvent the standard plugin directory structure, in which case the newly created plugin may also need to be loaded by full path
| Name | CreateAndLoadNewPlugin |
| Type | function |
| Header File | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h |
| Include Path | #include "PluginUtils.h" |
| Source | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Private/PluginUtils.cpp |
static TSharedPtr < IPlugin > CreateAndLoadNewPlugin
(
const FString & PluginFilePath,
const FNewPluginParams & CreationParams,
FLoadPluginParams & LoadParams
)
The newly created plugin. If something goes wrong during the creation process, the plugin folder gets deleted and null is returned.
Parameters
| Name | Remarks |
|---|---|
| PluginFilePath | Plugin descriptor file path |
| CreationParams | Plugin creation parameters |
| MountParams | Plugin loading parameters |
CreateAndLoadNewPlugin(const FString &, const FNewPluginParamsWithDescriptor &, FLoadPluginParams &)
Description
Helper to create and load a new plugin
MountParams.OutFailReason outputs the reason the plugin creation or loading failed (if applicable)
Will fail if the plugin already exists
This function can circumvent the standard plugin directory structure, in which case the newly created plugin may also need to be loaded by full path
| Name | CreateAndLoadNewPlugin |
| Type | function |
| Header File | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h |
| Include Path | #include "PluginUtils.h" |
| Source | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Private/PluginUtils.cpp |
static TSharedPtr < IPlugin > CreateAndLoadNewPlugin
(
const FString & PluginFilePath,
const FNewPluginParamsWithDescriptor & CreationParams,
FLoadPluginParams & LoadParams
)
The newly created plugin. If something goes wrong during the creation process, the plugin folder gets deleted and null is returned.
Parameters
| Name | Remarks |
|---|---|
| PluginFilePath | Plugin descriptor file path |
| CreationParams | Plugin creation parameters |
| LoadParams | Plugin loading parameters |
CreateAndLoadNewPlugin(const FString &, const FString &, const FNewPluginParams &, FLoadPluginParams &)
Description
Helper to create and load a new plugin
MountParams.OutFailReason outputs the reason the plugin creation or loading failed (if applicable)
Will fail if the plugin already exists
| Name | CreateAndLoadNewPlugin |
| Type | function |
| Header File | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h |
| Include Path | #include "PluginUtils.h" |
| Source | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Private/PluginUtils.cpp |
static TSharedPtr < IPlugin > CreateAndLoadNewPlugin
(
const FString & PluginName,
const FString & PluginLocation,
const FNewPluginParams & CreationParams,
FLoadPluginParams & LoadParams
)
The newly created plugin. If something goes wrong during the creation process, the plugin folder gets deleted and null is returned.
Parameters
| Name | Remarks |
|---|---|
| PluginName | Plugin name |
| PluginLocation | Directory that contains the plugin folder |
| CreationParams | Plugin creation parameters |
| MountParams | Plugin loading parameters |
CreateAndLoadNewPlugin(const FString &, const FString &, const FNewPluginParamsWithDescriptor &, FLoadPluginParams &)
Description
Helper to create and load a new plugin
MountParams.OutFailReason outputs the reason the plugin creation or loading failed (if applicable)
Will fail if the plugin already exists
| Name | CreateAndLoadNewPlugin |
| Type | function |
| Header File | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h |
| Include Path | #include "PluginUtils.h" |
| Source | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Private/PluginUtils.cpp |
static TSharedPtr < IPlugin > CreateAndLoadNewPlugin
(
const FString & PluginName,
const FString & PluginLocation,
const FNewPluginParamsWithDescriptor & CreationParams,
FLoadPluginParams & LoadParams
)
The newly created plugin. If something goes wrong during the creation process, the plugin folder gets deleted and null is returned.
Parameters
| Name | Remarks |
|---|---|
| PluginName | Plugin name |
| PluginLocation | Directory that contains the plugin folder |
| CreationParams | Plugin creation parameters |
| LoadParams | Plugin loading parameters |
CreateAndLoadNewPlugin(const FString &, const FString &, const FString &, const FNewPluginParamsWithDescriptor &, FLoadPluginParams &)
Description
Helper to create and load a new plugin
MountParams.OutFailReason outputs the reason the plugin creation or loading failed (if applicable)
Will fail if the plugin already exists
| Name | CreateAndLoadNewPlugin |
| Type | function |
| Header File | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Public/PluginUtils.h |
| Include Path | #include "PluginUtils.h" |
| Source | /Engine/Plugins/Developer/PluginUtils/Source/PluginUtils/Private/PluginUtils.cpp |
static TSharedPtr < IPlugin > CreateAndLoadNewPlugin
(
const FString & PluginName,
const FString & NameToReplace,
const FString & PluginLocation,
const FNewPluginParamsWithDescriptor & CreationParams,
FLoadPluginParams & LoadParams
)
The newly created plugin. If something goes wrong during the creation process, the plugin folder gets deleted and null is returned.
Parameters
| Name | Remarks |
|---|---|
| PluginName | Plugin name |
| NameToReplace | what will be used to replace PLUGIN_NAME in the given templates. Pass in PluginName here for default behavior |
| PluginLocation | Directory that contains the plugin folder |
| CreationParams | Plugin creation parameters |
| LoadParams | Plugin loading parameters |