UE编辑器-Slate快速入门【开篇】

void FSlateTestModule::StartupModule()
{
    // This code will execute after your module is loaded into memory; the exact timing is specified in the .uplugin file per-module
    
    /* 初始化SlateStyle样式，加载图标等 */
    FSlateTestStyle::Initialize();
    FSlateTestStyle::ReloadTextures();
    
    /* 注册Commmand管理器，映射绑定输入指令和操作功能 */
    FSlateTestCommands::Register();
    PluginCommands = MakeShareable(new FUICommandList);
    PluginCommands->MapAction(
        FSlateTestCommands::Get().OpenPluginWindow,
        FExecuteAction::CreateRaw(this, &FSlateTestModule::PluginButtonClicked),
        FCanExecuteAction());
    
    /* 为模块注册在菜单栏和工具栏上的入口 */
    UToolMenus::RegisterStartupCallback(FSimpleMulticastDelegate::FDelegate::CreateRaw(this, &FSlateTestModule::RegisterMenus));
    
    /* 为该模块注册一个Tab显示窗口 */
    FGlobalTabmanager::Get()->RegisterNomadTabSpawner(SlateTestTabName, FOnSpawnTab::CreateRaw(this, &FSlateTestModule::OnSpawnPluginTab))
        .SetDisplayName(LOCTEXT("FSlateTestTabTitle", "SlateTest"))
        .SetMenuType(ETabSpawnerMenuType::Hidden);
}
​
​
void FSlateTestModule::PluginButtonClicked()
{   
    /* 触发注册在TabManager中的Tab窗口 */
    FGlobalTabmanager::Get()->TryInvokeTab(SlateTestTabName);
}

/* 该函数为Slate的Tab主界面的生成函数  */ 
TSharedRef<SDockTab> FSlateDemoOneModule::OnSpawnPluginTab(const FSpawnTabArgs& SpawnTabArgs)
{
    /* 设置展示文本  */ 
    FText WidgetText = FText::Format(
        LOCTEXT("WindowWidgetText", "Add code to {0} in {1} to override this window's contents"),
        FText::FromString(TEXT("FSlateDemoOneModule::OnSpawnPluginTab")),
        FText::FromString(TEXT("SlateDemoOne.cpp"))
        );
    
    /* 链式编程构建界面 */
    return SNew(SDockTab)
        .TabRole(ETabRole::NomadTab)
        [
            // Put your tab content here!
            SNew(SBox)
            .HAlign(HAlign_Center)
            .VAlign(VAlign_Center)
            [
                SNew(STextBlock)
                .Text(WidgetText)
            ]
        ];
}

/* 在编辑器菜单栏和工具栏拓展按钮 */
void FSlateDemoOneModule::RegisterMenus()
{
    // Owner will be used for cleanup in call to UToolMenus::UnregisterOwner
    FToolMenuOwnerScoped OwnerScoped(this);
​
    {   
        /*  主菜单栏中插入触发按钮  */
        UToolMenu* Menu = UToolMenus::Get()->ExtendMenu("LevelEditor.MainMenu.Window");
        {   
            //在WindowLayout位置片区添加触发按钮
            FToolMenuSection& Section = Menu->FindOrAddSection("WindowLayout");
            Section.AddMenuEntryWithCommandList(FSlateDemoOneCommands::Get().OpenPluginWindow, PluginCommands);
        }
    }
​
    {
        /*  主工具栏中插入触发按钮  */  
        UToolMenu* ToolbarMenu = UToolMenus::Get()->ExtendMenu("LevelEditor.LevelEditorToolBar.PlayToolBar");
        {
            // 在工具栏的Settings片区中添加触发按钮
            FToolMenuSection& Section = ToolbarMenu->FindOrAddSection("Settings");
            {
                FToolMenuEntry& Entry = Section.AddEntry(FToolMenuEntry::InitToolBarButton(FSlateDemoOneCommands::Get().OpenPluginWindow));
                Entry.SetCommandList(PluginCommands);
            }
        }
    }
}

// Commands.h文件
class FSlateTestCommands : public TCommands<FSlateTestCommands>
{
    /* .....................................  */
public:
    TSharedPtr< FUICommandInfo > OpenPluginWindow;
};
​
​
// Commands.cpp 文件
void FSlateTestCommands::RegisterCommands()
{
    UI_COMMAND(OpenPluginWindow, "SlateTest", "Bring up SlateTest window", EUserInterfaceActionType::ToggleButton, FInputChord());
}

//.h 
TSharedPtr<class FUICommandList> PluginCommands;
​
//.cpp   
PluginCommands = MakeShareable(new FUICommandList);   //创建管理类
PluginCommands->MapAction( FTestMenuCommands::Get().PluginAction, TestFExecuteAction::CreateRaw(this, &FSlateTestModule::PluginButtonClicked), FCanExecuteAction());  // 创建绑定

UToolMenu* ToolbarMenu = UToolMenus::Get()->ExtendMenu("LevelEditor.LevelEditorToolBar.PlayToolBar");
{
    FToolMenuSection& Section = ToolbarMenu->FindOrAddSection("Settings");
    {   
        // 传入命令FUICommandInfo
        FToolMenuEntry& Entry = Section.AddEntry(FToolMenuEntry::InitToolBarButton(FSlateTestCommands::Get().OpenPluginWindow));
        // 传入命令管理器FUICommandList（用于获取命令对应的Action)
        Entry.SetCommandList(PluginCommands);
    }
}

TSharedRef< FSlateStyleSet > FSlateTestToolBarStyle::Create()
{
    /* 创建SlateStyleSet */
    TSharedRef< FSlateStyleSet > Style = MakeShareable(new FSlateStyleSet("SlateTestStyle"));
    
    /* 设置样式集资产读取路径  */
    Style->SetContentRoot(IPluginManager::Get().FindPlugin("SlateTest")->GetBaseDir() / TEXT("Resources"));
    
    /* 存储名为 SlateTest.PluginAction 的BrushStyle到StyleSet中 */
    Style->Set("SlateTest.PluginAction", new IMAGE_BRUSH_SVG(TEXT("PlaceholderButtonIcon"), Icon20x20));
    return Style;
}

/* --------------注册并使用---------------*/
// 创建一个新的样式集
FSlateStyleSet* StyleSet = new FSlateStyleSet("MyStyleSet");
​
// 定义一个样式属性并存储到StyleSet
FSlateBrush ButtonBrush = FSlateBrush();
ButtonBrush.TintColor = FSlateColor(FLinearColor::Red);
StyleSet->Set("MyButtonStyle", ButtonBrush);
​
// 注册样式集
FSlateStyleRegistry::RegisterSlateStyle(*StyleSet);
​
// 在创建按钮时，使用这个样式
SNew(SButton)
    .ButtonStyle(StyleSet, "MyButtonStyle")
    .Text(FText::FromString("My Button"));
​
​
/* --------------注销---------------*/
// 使用完后，找合适的时机注销StyleSet
FSlateStyleRegistry::UnRegisterSlateStyle(*StyleSet);
StyleSet.Reset();  

{
    "FileVersion": 3,
    "Version": 1,                    
    "VersionName": "1.0",
    "FriendlyName": "SlateTest",
    "Description": "", 
    "Category": "Other",            //作者
    "CreatedBy": "CloudBoy",
    "CreatedByURL": "",
    "DocsURL": "",
    "MarketplaceURL": "",
    "SupportURL": "",
    "CanContainContent": false,
    "IsBetaVersion": false,
    "IsExperimentalVersion": false,
    "Installed": false,
    "Modules": [
        {
            "Name": "SlateTest",                     //插件模块命名
            "Type": "Editor",                        //模块的类型，决定能加载模块的应用程序类型  EHostType::Type
            "LoadingPhase": "Default"                //模块加载策略  ELoadingPhase::Type
        }
    ]
}

namespace EHostType
{
    enum Type
    {
        Runtime,             //表示模块可以加载到所有目标中，除了【程序】
        RuntimeNoCommandlet, //表示模块可以加载到所有目标中，除了【程序】和运行【命令模式】的编辑器。
        RuntimeAndProgram,   //表示模块可以加载到所有目标中，包括支持的【程序】
        CookedOnly,          //表示模块只能在已经打包的游戏中加载
        UncookedOnly,        //表示模块只能在未打包的游戏中加载
        Developer,           //UE5中因存在歧义被废弃，不建议使用：表示模块只能在编辑器和【程序】中加载，可以在任何编辑器模式下加载（例如 -game、-server）
        Editor,              //表示模块只能在编辑器启动时加载
        EditorNoCommandlet,  //表示模块只能在编辑器启动时加载，但不能在【命令模式】下加载。
        EditorAndProgram,    //表示模块只能在编辑器和【程序】中加载
        Program,             //只有运行独立【程序】时的插件
        ServerOnly,          //表示模块可以加载到除了专用客户端之外的所有目标中
        ClientOnly,          //表示模块可以加载到除了专用服务器之外的所有目标中
        ClientOnlyNoCommandlet, //在客户端和编辑器下加载，但不能在 【命令模式】下
    };
}

namespace ELoadingPhase
{
    enum Type
    {
        PostConfigInit,         //引擎完全加载前，配置文件加载后。适用于较底层的模块。
        PreEarlyLoadingScreen,  //在UObject加载前，用于补丁系统
        PreLoadingScreen,       //在引擎模块完全加载和加载页面之前
        PreDefault,             //默认模块加载之前阶段
        Default,                //默认加载阶段，在引擎初始化时，游戏模块加载之后
        PostDefault,            //默认加载阶段之后加载
        PostEngineInit,         //引擎初始化后
        None,                   //不自动加载模块
    };
}

当然，为代码添加注释可以帮助读者更好地理解Slate插件的创建过程。以下是完整代码及其注释：
​
// 在 #include 中添加您需要使用的模块
#include "Slate/Public/SlateBasics.h"
#include "Slate/Public/Widgets/Text/STextBlock.h"
#include "Slate/Public/Widgets/Input/SButton.h"
#include "Slate/Public/Widgets/Layout/SBox.h"
​
// 创建一个新的UE4插件项目
class FSlatePlugin : public IModuleInterface
{
public:
    /** IModuleInterface implementation */
    void StartupModule();
    void ShutdownModule();
};
​
void FSlatePlugin::StartupModule()
{
    // 在此处添加您的模块启动代码
}
​
void FSlatePlugin::ShutdownModule()
{
    // 在此处添加您的模块关闭代码
}
​
// 实现UMG插件
IMPLEMENT_MODULE(FSlatePlugin, SlatePlugin)
​
// 创建一个继承自 SCompoundWidget 的 Slate Widget
class SLATEPLUGIN_API SSlatePluginWidget : public SCompoundWidget
{
public:
    // 在 begin_args 和 end_args 中定义您的构造函数所需的任何成员变量
    SLATE_BEGIN_ARGS(SSlatePluginWidget) {}
    SLATE_END_ARGS()
​
    // 构造函数
    void Construct(const FArguments& InArgs)
    {
        // 定义子窗口
        ChildSlot
        [
            SNew(SBox)
            [
                SNew(STextBlock)
                .Text(FText::FromString("Hello, World!"))
            ]
        ];
    }
};
​
// 添加一个按钮到 Slate Widget
void Construct(const FArguments& InArgs)
{
    // 定义子窗口
    ChildSlot
    [
        SNew(SBox)
        [
            SNew(SButton)
            // 设置按钮文本
            .Text(FText::FromString("Click me!"))
            // 设置按钮点击事件
            .OnClicked(this, &SSlatePluginWidget::HandleButtonClick)
        ]
    ];
}
​
// 处理按钮点击事件
FReply HandleButtonClick()
{
    // 在此处添加您需要实现的代码
    return FReply::Handled();
}
​
// 将插件添加到项目中
PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "Slate", "SlateCore" });

// NewWdiget.h
#pragma once
​
class NewWidget : public SCompoundWidget
{
public:
    SLATE_BEGIN_ARGS(NewWidget) {}
    SLATE_END_ARGS()
​
    void Construct(const FArguments& InArgs);
};
​
// NewWdiget.cpp
#include "NewWidget.h"
void NewWidget::Construct(const FArguments& InArgs)
{
    ChildSlot[
        SNew(SButton)
    ];
}

#pragma once
​
class NewWidget : public SCompoundWidget
{
public:
    SLATE_BEGIN_ARGS( NewWidget )
        : _IsFocusable( false )
    {}
        SLATE_ARGUMENT( bool, IsFocusable )
    
    SLATE_END_ARGS()
​
    void Construct(const FArguments& InArgs);
​
private:
    bool IsFocusable;
};

#include "NewWidget.h"
​
void NewWidget::Construct(const FArguments& InArgs)
{
    IsFocusable = InArgs._IsFocusable ;
    
    //插槽中创建一个按钮
    ChildSlot[
        SNew(SButton)
    ];
​
}

#include "NewWidget.h"   //首先引入头文件
​
TSharedRef<SDockTab> FCloudBoyModule::OnSpawnPluginTab(const FSpawnTabArgs& SpawnTabArgs)
{
    FText WidgetText = FText::Format(
        LOCTEXT("WindowWidgetText", "Add code to {0} in {1} to override this window's contents"),
        FText::FromString(TEXT("FCloudBoyModule::OnSpawnPluginTab")),
        FText::FromString(TEXT("CloudBoy.cpp"))
        );
​
    TSharedPtr<NewWidget> testWdiget;  //定义指针
​
    return SNew(SDockTab)
        .TabRole(ETabRole::NomadTab)
        [
            // Put your tab content here!
            SAssignNew(testWdiget, NewWidget)    //创建自定义控件
            .IsFocusable(true)                   //初始化自定义参数
        ];
}