[UE4]独自プラグインを作成する #UnrealEngine

今回は自作プラグインの作成例を紹介したいと思います。
アンリアルエンジンにおけるプラグインは、ゲームプロジェクトそのもの、もしくはエディタに追加の機能を持たせることができます。
これを覚える事でより一層深くアンリアルエンジンを自由に使うことができるので、是非試してみてください。

プロジェクトの準備

ではまず今回の演習用の新規プロジェクトを作成します。
アンリアルエディタから、NewProject -> C++ -> BasicCode を選択してください。
名前はなんでも構いません。ボクはプロジェクト名を"MyPluginTest"とします。
次に、 File -> NewLevel から "Default"を選択し、新規レベルを作成してください。
Content以下に"Maps"フォルダを作り、その中に"TestLevel"として今の新規作成したレベルを保存しましょう

次にプラグインの雛型を作ります。
エディタのEdit -> Plugins を押してPluginsのウィンドウを開きます。

すると、次のような画面が開くと思いますので、右下のNewPluginをクリックします。

新規プラグイン作成ウィンドウになるので、Blankを選択し、名前を"TestPlugin"にします。
Descriptor Dataには、このプラグインの詳細情報を入力します。必須項目ではないので入力しなくても大丈夫です。
自分がプラグインをGithubかアンリアルのマーケットプレイスで公開する時に入力するものです。

コンパイルが済んだら、先ほどのPluginsウィンドウの左タブの一番下に、自分が作成した"TestProject"が追加されているのが確認できると思います。
この時点でなんかもぅやったった感があるんですが楽しくなるのはこれからです。

では、新規クラスを作成する為に、ContentBrowser -> AddNew -> C++ Classをクリックします。
そして以下のように Show All Classesを押してObjectを選択してNextを押してください。

モジュール選択で先ほど作ったプラグインを指定して、名前を"TestFunctions"にして作成します。
Pluginでも普通にUE内だけでC++クラスを作るようにPublicかPrivateを選択します。
メソッドとして公開したいやつだけをPublicにして不要なファイルを公開しないようにしましょう。
今回はPublicで生成します。

では、.slnファイルを開いてみて、今まで作成したプラグインとスクリプトが反映されているか確認してみましょう。
以下の画像のようになっていたら無事生成できています。
Resourceフォルダにはこのプラグインのサムネイル画像が保存されています。

プラグインの概要

Pluginファイル本体の拡張子は.upluginです。ちなみにもこの.upluginは必ずしもPluginsフォルダ直下にある必要はないです。
UEではモジュール単位でスクリプトの機能を管理しています。Build.csファイルがプロジェクト側にも、プラグイン側にもあるのが確認できますか？
このファイルにそれぞれのスクリプトで用いるモジュールを記述して読み込みます。
今回は特に使用しないので割愛しますが、次回以降の記事で掘り下げていこうと思います。

プラグインにスクリプトを記述する

それでは先ほど作ったファイルにソースコードを記述していきます。
中身は以下のように書き換えてみましょう

TestFunctions.h

#pragma once

#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "TestFunctions.generated.h"

UCLASS(Blueprintable)
class TESTPLUGIN_API UTestFunctions : public UObject
{
    GENERATED_BODY()

    UFUNCTION(BlueprintCallable, Category = "IwaxLab")
    static bool WriteLocation(AActor* Actor);

    UFUNCTION(BlueprintCallable, Category = "IwaxLab",
        meta = (WorldContect = "WorldContextObject"))
    static AActor* GenerateCameraActor(AActor* BaseActor, FVector Location);

};

TestFunctions.cpp

// Fill out your copyright notice in the Description page of Project Settings.


#include "TestFunctions.h"
#include "Engine.h"
#include <string>
#include <fstream>

bool UTestFunctions::WriteLocation(AActor* Actor)
{
    if (!Actor) return false;

    //パスの設定
    FString filepath_str = FPaths::ProjectLogDir() / "ActorLocation.txt";
    //stringに変換
    const std::string filepath(TCHAR_TO_UTF8(*filepath_str));


    //Actorのラベルを取得
    FString label_str = Actor->GetActorLabel();
    //stringに変換
    const std::string label(TCHAR_TO_UTF8(*label_str));


    //Actorの座標を取得
    FVector location = Actor->GetActorLocation();


    //座標を書き込み std::ios::appにすると追記モードになる
    std::ofstream ostr(filepath, std::ios::out);
    ostr << label << ":"
        << location.X << ","
        << location.Y << ","
        << location.Z << std::endl;

    return true;

}

//=======================================================

AActor* UTestFunctions::GenerateCameraActor(AActor* BaseActor, FVector Location)
{

    if (!BaseActor) return nullptr;


    //引数に入れたActorから、それが存在するUWorldを取得
    UWorld* World = BaseActor->GetWorld();


    //カメラアクタを生成
    AActor* Actor = World->SpawnActor<ACameraActor>();
    //アクタのラベル
    Actor->SetActorLabel("TestCamera");
    //アクタの位置
    Actor->SetActorLocation(Location);
    //Actor->SetActorLocation(Location);


    //ちなみにアクタの削除は以下のメソッド
    //AActor::Destroy()


    //生成したActorを戻り値として返す
    return Actor;

}

エディタ側でPluginを再コンパイルする

記述出来たらエディタから WIndow->Developer Tools -> Modulesをクリックし、Modulesウィンドウを開きます。

その中に"TestPlugin"が確認できると思うので"ReCompile"を押してコンパイルしてみましょう。
入力に間違いがなければコンパイルが通るはずです。
どうしてもうまくいかない場合は一度エディタを再起動してみてください

Blueprintから扱ってみる

無事コンパイルできましたか？ではでは早速ブループリントから使ってみましょう。
ただそのまえに、カメラを生成するためのレベル情報を取得する為にCubeを一つ作っておきます。
以下の座標に配置してみてください。名前はBaseCubeとします。

では、いざレベルブループリントを開きましょう。
ツールバーのBlueprintsからOpenLevelBlueprintで開いてください
そして以下の画像のようにしてみましょう

やっていることとしては、先ほど作成した"BaseCube"からレベル情報を取得して、その同一レベルにカメラアクタを新規作成し、Cubeに対して正面に来る座標でスポーンするようにしています。
そしてその生成したカメラの座標をログとして外部ファイルにテキストファイル形式で書き出しています。

いざプレイ

worldOutlinerにTestCameraが追加されてCubeが画角に収まっているのがわかりますでしょうか？
また、./MyPluginTest/Saved/LogsフォルダにActorLocation.txtがあり、座標データが保存されているはずです。
こんな風に、プラグインを用いれば共同開発などで扱いやすい形で独自の機能をアンリアルに付与することができます。

[UE4]独自プラグインを作成する https://t.co/1O8ctL9YA1 pic.twitter.com/TX62VnNbFO
— iwax (@iwax51101141) September 15, 2019

お疲れさまでした

以上が基本のプラグイン制作例になります。これを元に是非色々な独自プラグインを是非作ってみてください。
それではまた！