ue5-plugins-tools-cheatsheet

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #llm #go #golang #android #rust #deep-learning #linux #pytorch #mcp

ue5-plugins-tools-cheatsheet

(★ 10)

Simple notes on how to create plugins for Unreal Engine 5.

ue5-plugins-tools-cheatsheet Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ue5-plugins-tools-cheatsheet
Simple notes on how to create plugins and tools for Unreal Engine 5.

## Environment:
- Windows 11/10
- Engine version: 5.x.x
- Project Codebase: C++ (Noted if anything else like Blueprints, Python, etc.)
- IDE: Visual Studio 2022 or JetBrains Rider

## Useful Classes/Libraries for Developing UE5 Tools
- [FMessageDialog](https://docs.unrealengine.com/5.2/en-US/API/Runtime/Core/Misc/FMessageDialog/)
    ```c++
    // Create and draw a popup modal.
    // Basically returns which button on the modal was clicked.
    EAppReturnType::Type Open(
        EAppMsgType::Type MessageType, // Determines the set of buttons in the modal.
        const FText& Message,
        const FText* OptTitle) // Title of the modal window.
    ```

- [FNotificationInfo](https://docs.unrealengine.com/5.2/en-US/API/Runtime/Slate/Widgets/Notifications/FNotificationInfo/) and [FSlateNotificationManager](https://docs.unrealengine.com/5.2/en-US/API/Runtime/Slate/Framework/Notifications/FSlateNotificationManager/)
    ```c++
    // Use to create toast notifications for the Editor, such as when the execution of your tool has finished.
    // Basic usage case:
    FString& Message = TEXT("Custom tool functionality is done!");
    FNotificationInfo NotifyInfo(FText::FromString(Message)); // Constructor
	NotifyInfo.bUseLargeFont = true;
	NotifyInfo.FadeOutDuration = 7.f; // Toast will fade out in 7 seconds.
    // Basically makes the toast appear.
	FSlateNotificationManager::Get().AddNotification(NotifyInfo);
    ```
- [UEditorUtilityLibrary](https://docs.unrealengine.com/5.2/en-US/API/Editor/Blutility/UEditorUtilityLibrary/) (part of the ```Blutility``` module)

```c++
    // Gets the set of currently selected assets (in the Content Browser)
    static TArray<UObject*> GetSelectedAssets()
    // Get the set of asset data from currently selected assets (in the Content Browser)
    static TArray<FassetData&> GetSelectedAssetData()
    ```
- [UEditorAssetLibrary](https://docs.unrealengine.com/4.26/en-US/API/Plugins/EditorScriptingUtilities/UEditorAssetLibrary/) (part of the ```EditorScriptingUtilities``` module)

```c++
    // Duplicates an asset (from source path to destination path)
    static UObject * DuplicateAsset(
        const FString& SourceAssetPath, 
        const FString& DestinationPath)
    ```

- [UGameplayStatics](https://docs.unrealengine.com/5.2/en-US/API/Runtime/Engine/Kismet/UGameplayStatics/) (part of ```Core``` module)

```c++
    // Find all actors of a certain class in the Level.
    static void GetAllActorsOfClass(
        const UObject* WorldContextObject, // usually UWorld* object by calling GEditor->GetEditorWorldContext().World()
        TSubclassOf<AActor> ActorClass, // usually entered as MyActorClass::StaticClass()
        TArray<AActor*> &OutActors) // The "return" array.
    ```
# Creating Plugin Module
1. In the UE Editor, go to top menu->Edit->Plugins:

![Menu Item Plugins](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/01_create_plugin.png "Plugins menu")

2. In the Plugins Window, click +Add:

![Plugins Window](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/02_create_plugin.png "Plugins window")

3. In the New Plugin Window, select your template type, enter the folder path for your new plugin, and enter you new plugin's name.

![New Plugin Window](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/03_create_plugin.png "New Plugin window")
    
- Try to get your Plugin Name correct here, as renaming a plugin later on can be tedious.
- Entries for Descriptor Data and Advanced items are optional.
- Show Content Directory should remain checked.

4. Go to Visual Studio for the project (if not already open, go to Tools->Open Visual Studio).

5. In VS, open your .uplugin file (usually under Games/ProjectName/Plugins/PluginName/ in the Solution Explorer).

6. In the .uplugin file, change Modules.{firstObject}.Type to "Editor" and Modules.{firstObject}.LoadingPhase to "PreDefault".

![uplugin file](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/04_create_plugin.png "uplugin file")

7. Close your Editor project, and then re-build the C++ project in VS (can use the shortcut Ctrl+F5), which will also re-open the Editor.

# Asset Action Utility ([UAssetActionUtility](https://docs.unrealengine.com/5.2/en-US/API/Editor/Blutility/UAssetActionUtility/))
- A right-click menu item function (under "Scripted Asset Actions") on an asset in the Content Browser.
1. In the Editor, select top menu->Tools->New C++ Class...

![New C++ Class](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/05_asset_action_utility.png "New C++ Class")

2. In the Add C++ Class window, select "All Classes", and type "AssetActionUtility" in the search bar.  Then, click Next>.

![Add C++ Class](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/06_asset_action_utility.png "Add C++ Class")

3. Give your new Class a name.  Make sure it is public and that it is part of your plugin project.

![Name new C++ Class](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/06a_asset_action_utility.png "Name new C++ Class")

4. Add the Blutility module to PublicDependencyModuleNames in the Plugin's Build.cs file.  (The Blutility module is what contains the UAssetActionUtlity's header file.)

![Add Blutility](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/07_asset_action_utility.png "Add Blutility")

5. Since the Blutility module is private, we must also add the path of this module to the PrivateIncludePaths array:

![Add Blutility Private Path](https://raw.githubusercontent.com/ryanthtra/ue5-plugins-tools-cheatsheet/main/img/08_asset_action_utility.png "Add Blutility Private Path")

6. In the IDE and in the header file for your new Asset Action Utility subclass, declare the function that will be the menu item.  Give it the ```UFUNCTION(CallInEditor)``` attribute.

```c++
    UCLASS()
    class MYPLUGIN_API UMyAssetAction : public UAssetActionUtility
    {
        GENERATED_BODY()

public:
        UFUNCTION(CallInEditor)
        void MyFunction();
    ...
    ```

ue5-plugins-tools-cheatsheet

ue5-plugins-tools-cheatsheet Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ue5-plugins-tools-cheatsheet

ue5-plugins-tools-cheatsheet Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README