UE4 在游戏中使用Slate

超、凢脫俗 2022-08-19 08:19 184阅读 0赞

# 在游戏中使用Slate #

[Slate用户界面架构][Slate]

## 概述 ##

Slate控件可以用于在游戏中创建平头显示信息(HUD)或其他用户界面(UI)元素， 比如菜单。您一般可以创建一个或多个 *容器* 控件，每个容器可以包含几个其他类型的控件， 这些控件负责用户界面的特定方面。

比如，您可能具有一个针对游戏HUD的总体控件，同时具有针对主菜单、 选项菜单、暂停菜单、记分板等的各种控件。每种控件又可能由其他 自定义控件、标签、文本框、图片及其他类型的元素构成。

然后，可以根据游戏情境添加或删除这些容器控件：

*  当游戏启动时，将添加主菜单控件。
 *  当他们选择菜单中的其中一个选项时 - 可能是启动游戏 - 那么主菜单控件将会被删除。
 *  如果玩家在任何时候暂停了游戏，那么将会添加暂停菜单控件。
 *  当游戏继续时，将会删除暂停菜单控件。
 *  当为玩家初始化了HUD时，将会添加HUD控件。

## 项目设置 ##

为了使用Slate用户界面架构，您的项目必须进行适当的设置，以便它可以意识到该 架构。这允许您包含 `Slate.h` 头文件及引用使用Slate构建用户界面 所需的各种架构元素。

### 模块依赖 ###

Slate架构存储在几个模块中。为了使您的项目意识到这些模块的存在， 则必须在 \*.build.cs 文件中为您的项目设置一些依赖项。

您的项目需要访问的模块是：

<table style="border-top-width:1px; border-top-style:solid; border-top-color:rgb(160,160,160); border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(160,160,160); border-spacing:0px; width:930px; margin:1.5em 0em; font-size:0.925em; color:rgb(22,22,23); font-family:Helvetica,Verdana,Arial,sans-serif; line-height:26.25px; background-color:transparent">      
 <thead> 
  <tr> 
   <th colspan="1" style="border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); color:rgb(0,0,0); padding:0.25em 2.5em 0.25em 0.5em; vertical-align:top; background-color:rgb(224,224,224)"> 模块</th> 
   <th colspan="1" style="border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); color:rgb(0,0,0); padding:0.25em 2.5em 0.25em 0.5em; vertical-align:top; background-color:rgb(224,224,224)"> 依赖类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1" align="" style="border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); vertical-align:top; padding:0.25em 2.5em 0.25em 0.5em"> InputCore</td> 
   <td colspan="1" align="" style="border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); vertical-align:top; padding:0.25em 2.5em 0.25em 0.5em"> 公有</td> 
  </tr> 
  <tr> 
   <td colspan="1" align="" style="border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); vertical-align:top; padding:0.25em 2.5em 0.25em 0.5em"> Slate</td> 
   <td colspan="1" align="" style="border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); vertical-align:top; padding:0.25em 2.5em 0.25em 0.5em"> 私有</td> 
  </tr> 
  <tr> 
   <td colspan="1" align="" style="border-bottom-width:0px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); vertical-align:top; padding:0.25em 2.5em 0.25em 0.5em"> SlateCore</td> 
   <td colspan="1" align="" style="border-bottom-width:0px; border-bottom-style:solid; border-bottom-color:rgb(216,216,216); vertical-align:top; padding:0.25em 2.5em 0.25em 0.5em"> 私有</td> 
  </tr> 
 </tbody> 
</table>

**要想设置Slate模块的依赖项:**

1.  打开您的项目的 `[ProjectName].build.cs` 文件。它位于 `[ProjectDir]/[ProjectName]/Source/[ProjectName]` 目录中。
2.  通过将 `"InputCore"` 添加到 `PublicDependencyModuleNames` 中，来添加InputCore公有依赖。
    
        PublicDependencyModuleNames.AddRange(new string[] {
               "Core", "CoreUObject", "Engine", "InputCore" });
    
    当创建代码项目时，InputCore默认设置为公有依赖。
3.  添加Slate和SlateCore私有依赖。\*.build.cs文件中有一行代码用于添加私有依赖：
    
        PrivateDependencyModuleNames.AddRange(new string[] {
                });
    
    您所需要做的就是将SlateCore和Slate模块添加到那行代码中：
    
        PrivateDependencyModuleNames.AddRange(new string[] {
               "Slate", "SlateCore" });
    
    根据您创建项目的时机及其引擎版本的不同，它可能已经在 \*.build.cs文件中设置了依赖项，但是注释掉了。您可以简单地取消注释适当的代码行来 设置依赖！
    
        // Uncomment if you are using Slate UI
        // PrivateDependencyModuleNames.AddRange(new string[] { "Slate", "SlateCore" });

## 显示控件 ##

为了在您的游戏中显示一个Slate控件，则必须将该控件添加到游戏视口中。重叠的控件 按照添加它们时指定的Z-排序进行排序，且较大的Z-排序值出现在较小的Z-排序值 的上面。

**访问游戏视口**

游戏视口是 `GameViewportClient` 类的一个实例。到当前游戏视口的引用可以通过 UEngine 的 `GameViewport` 成员获得，该成员可以通过使用到游戏当前UEngine实例 的`GEngine` 指针访问。

比如：

GEngine->GameViewport

因为 `GEngine` 和 `GameViewport` 都可以为 `NULL` ，所以在您尝试访问它们或者 其任何成员时，总是应该判断它们的值。

**向视口中添加控件**

Slate控件通过向 `GameViewportClient::AddViewportWidgetContent()` 传入一个到该控件的引用(确切地说是 `TSharedref<SWidget>` ) 来添加到视口中。该函数取入一个控件和Z-排序，Z-排序 向前面所提到的那样决定了新控件的排列顺序。Z-排序是可选的，但是其默认值为 `0` 。

到您想添加到视口中的控件的引用可以存储为某个类的一个成员，比如您的HUD， 或者可以在调用该函数时创建及传入该控件。

传入一个存储在成员变量中的控件引用(作为 `TSharedPtr` )：

GEngine->GameViewport->AddViewportWidgetContent(
        SNew(MyWidgetPtr.ToSharedRef())
    );

当将控件传入到 `GameViewportClient::AddViewportWidgetContent()` 时使用 `SNew()` 创建该控件：

GEngine->GameViewport->AddViewportWidgetContent(
        SNew(SWeakWidget)
        .PossiblyNullContent(MyWidgetClass)
    );

或者使用 `SAssignNew()` 来创建控件，并将它分配给 `TSharedPtr` 成员，然后传入它：

GEngine->GameViewport->AddViewportWidgetContent(
        SAssingNew(MyWidgetPtr, SWeakWidget)
        .PossiblyNullContent(MyWidgetClass)
    );

### 从视口中删除控件 ###

通过向 `GameViewportClient::RemoveViewportWidgetContent()` 中传入到先前添加的控件的引用， 可以从视口中单独地删除Slate控件。

比如：

GEngine->GameViewport->RemoveViewportWidgetContent(
        SNew(MyWidgetPtr.ToSharedRef())
    );

另外，通过调用 `GameViewportClient::RemoveAllViewportWidgets()` 可以立即删除所有控件。