unreal 自定义 Slate Style Sets

2022-11-06 22:13:08

搜集到的最有价值的一篇教学，按照作者的方法尝试中遇到了一些问题。【感谢这位作者!】

网址：https://wiki.unrealengine.com/Slate_Style_Sets_Part_2

在此，我将详述我的制作过程。本文原创，转载请写明出处，违者必究！

首先创建 xxStyle，我这里测试就以 Test命名。

 #pragma once

 #include "SlateStyle.h"

 class TestStyles

 {

 public:

     static void Initialize();

     static void Shutdown();

     static const class ISlateStyle& Get();

     static FName    GetStyleSetName();

 private:

     static TSharedRef<class FSlateStyleSet>    Create();

     static TSharedPtr<class FSlateStyleSet>    Instance;

 };

这个类是自己创建的，没有经过 UnrealEditor 的创建向导。（当然你也可以使用向导）

 #include "Test05.h"

 #include "TestStyles.h"

 #include "SlateGameResources.h"

 TSharedPtr<FSlateStyleSet> TestStyles::Instance = nullptr;

 void TestStyles::Initialize()

 {

     if (!Instance.IsValid())

     {

         Instance = Create();

         FSlateStyleRegistry::RegisterSlateStyle(*Instance);

     }

 }

 void TestStyles::Shutdown()

 {

     FSlateStyleRegistry::UnRegisterSlateStyle(*Instance);

     ensure(Instance.IsUnique());

     Instance.Reset();

 }

 const class ISlateStyle& TestStyles::Get()

 {

     return *Instance;

 }

 FName TestStyles::GetStyleSetName()

 {

     static FName StyleSetName(TEXT("TestStyles"));

     return StyleSetName;

 }

 TSharedRef<class FSlateStyleSet> TestStyles::Create()

 {

     return FSlateGameResources::New(TestStyles::GetStyleSetName(), "/game/ui", "/game/ui");

 }

这里需要注意：FSlateGameResources 资源路径的相对位置。 /game 代替了 /context，存放在 /context 目录下的资源，统一在地址路径中更名为 /game。

这个路径很重要！遇到错误的时候，一定要回来看看这个路径，看看能否找到 style 资源。

在这里，我没有按照网页中作者的方式创建 GameModule。（事实上我尝试了，但我失败了，暂时不想在此花费时间，所以改路。我放在了自定义的GameMode中）。

我认为只要能合理化的让 TestStyles 初始化，放哪都不是问题，（当然或许需要考虑创建的时序性，但目前我还没此顾虑）。

 AMyGameMode::AMyGameMode()

 {

    this->HUDClass = AMyHUD::StaticClass();

    FSlateStyleRegistry::UnRegisterSlateStyle(TestStyles::GetStyleSetName());// 参考网页的作者。只为防重复注册。

    TestStyles::Initialize();

 }

下面这个类，是由 UnrealEditor 向导生成的，操作如下：

在 Class 目录下创建 New Class。

 #pragma once

 #include "Styling/SlateWidgetStyle.h"

 #include "SlateWidgetStyleContainerBase.h"

 #include "GlobalTestWidgetStyle.generated.h"

 /**

  *

  */

 USTRUCT()

 struct TEST05_API FGlobalTestStyle : public FSlateWidgetStyle

 {

     GENERATED_USTRUCT_BODY()

 public:

     FGlobalTestStyle();

     virtual ~FGlobalTestStyle();

     // FSlateWidgetStyle

     virtual void GetResources(TArray<const FSlateBrush*>& OutBrushes) const override;

     static const FName TypeName;

     virtual const FName GetTypeName() const override { return TypeName; };

     static const FGlobalTestStyle& GetDefault();

     UPROPERTY(EditAnywhere, Category = Appearance)

     FTextBlockStyle textBlockStyle;

 };

 /**

  */

 UCLASS(hidecategories=Object, MinimalAPI)

 class UGlobalTestWidgetStyle : public USlateWidgetStyleContainerBase

 {

     GENERATED_BODY()

 public:

     /** The actual data describing the widget appearance. */

     UPROPERTY(Category=Appearance, EditAnywhere, meta=(ShowOnlyInnerProperties))

     FGlobalTestStyle WidgetStyle;

     virtual const struct FSlateWidgetStyle* const GetStyle() const override

     {

         return static_cast< const struct FSlateWidgetStyle* >( &WidgetStyle );

     }

 };

 #include "Test05.h"

 #include "GlobalTestWidgetStyle.h"

 FGlobalTestStyle::FGlobalTestStyle()

 {

 }

 FGlobalTestStyle::~FGlobalTestStyle()

 {

 }

 const FName FGlobalTestStyle::TypeName(TEXT("FGlobalTestStyle"));

 const FGlobalTestStyle& FGlobalTestStyle::GetDefault()

 {

     static FGlobalTestStyle Default;

     return Default;

 }

 void FGlobalTestStyle::GetResources(TArray<const FSlateBrush*>& OutBrushes) const

 {

 }

这里是重点，我自己在作者的网页中没有看懂，最终咨询了同事后试验才找到正路。

在 Content 目录中创建 Style. 这个地址一定要是之前提到的 FSlateGameResources::New( 中使用的地址，目前我用的是 /Game/ui 位置的地址，（参照上文解释）/Game/ui 的位置应该被替换成 /content/ui，如图：

在此创建：

得到一个资源，这个名字也很重要，之后要对应上。

现在就双击修改里面的内容。

这个东西会存在，就是因为自定义的 FSlateWidgetStyle 中定义了

  UPROPERTY(EditAnywhere, Category = Appearance)

  FTextBlockStyle textBlockStyle;

这正是它。

我修改了字体和字体大小。

到了最后一步，实例化显示了，测试代码片段如下，我写在

void AMyHUD::BeginPlay()

{

        // 注意，这里的 "TestButtonStyle01" 是资源的名字

        auto ss = TestStyles::Get().GetWidgetStyle<FGlobalTestStyle>("TestButtonStyle01");  

       textBlock = SNew(STextBlock)

                    .TextStyle(&ss.textBlockStyle)

                    .Text(FText::FromString("Hello World !"));   

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

}

所有步骤都做完了。可以显示了。效果如图：

原文中提到需要用到 Brush 的地方，以上代码不能工作，需要有其他步骤。测试成功后另写博文。

找到如何使Brush可用的方法：

void FGlobalTestStyle::GetResources(TArray<const FSlateBrush*>& OutBrushes) const

{
　　OutBrushes.Add(&m_brush);　　// 在这里添加需要的所有Brush,必须全部列出;
}

码农公寓

相关文章